diff options
| author | Nikolay Govorov <me@govorov.online> | 2026-01-12 22:54:29 +0000 |
|---|---|---|
| committer | Nikolay Govorov <me@govorov.online> | 2026-01-12 22:57:57 +0000 |
| commit | 59240dd3f462abfc07a6e6dc53eac047df4c60e5 (patch) | |
| tree | 2dbd3dc546931fae102dcf155b598a31f3dcd31b | |
| parent | 4137072731c36a3db3af8e0bd6f718b64d439d8b (diff) | |
| download | tar tar.gz tar.bz2 tar.lz tar.xz tar.zst zip | |
Add docs for installation, more detailed versions of packages
Diffstat
| -rw-r--r-- | .github/workflows/build.yml | 20 | +13 −7 |
| -rw-r--r-- | .github/workflows/cla.yml | 3 | +3 −0 |
| -rw-r--r-- | README.md | 48 | +48 −0 |
| -rw-r--r-- | REUSE.toml | 1 | +0 −1 |
4 files changed, 64 insertions, 8 deletions
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 28ea39b..8787a13 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2026 Nikolay Govorov <me@govorov.online> +# SPDX-License-Identifier: AGPL-3.0-or-later + name: Build on: @@ -60,8 +63,9 @@ jobs: - name: Build packages run: | + PKG_VERSION=$(cargo metadata --no-deps --format-version 1 | jq -r '.packages[0].version') + export VERSION="${PKG_VERSION}-dev.$(date +%s)+$(git rev-parse --short HEAD)" export ARCH=${{ matrix.arch }} - export VERSION=$(cargo metadata --no-deps --format-version 1 | jq -r '.packages[0].version') mkdir -p dist/ for pkg in deb rpm archlinux; do @@ -74,7 +78,7 @@ jobs: path: dist/* release: - name: Update nightly tag + name: Update dev tag runs-on: ubuntu-latest needs: [build] if: github.ref == 'refs/heads/main' @@ -83,13 +87,13 @@ jobs: steps: - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1 - - name: Update 'nightly' tag + - name: Update 'dev' tag run: | git config user.name "github-actions[bot]" git config user.email "41898282+github-actions[bot]@users.noreply.github.com" - git tag -f nightly - git push origin --force tag nightly + git tag -f dev + git push origin --force tag dev - uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 with: @@ -100,10 +104,12 @@ jobs: - name: Create GitHub Release uses: softprops/action-gh-release@a06a81a03ee405af7f2048a818ed3f03bbf83c7b # v2.5.0 with: - name: nightly - tag_name: nightly + name: dev + tag_name: dev files: dist/* body: | + Last successful build from `main` branch. + **Release checks**: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/cla.yml b/.github/workflows/cla.yml index 2ac3d95..754514c 100644 --- a/.github/workflows/cla.yml +++ b/.github/workflows/cla.yml @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2026 Nikolay Govorov <me@govorov.online> +# SPDX-License-Identifier: AGPL-3.0-or-later + name: "CLA Assistant" on: diff --git a/README.md b/README.md index da76059..e70aca5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,54 @@ Soon humanity will go to Mars and in order for the colonists to be able to program, we will need a local mirror of packages. +## Installation + +Please note that the project is in its infancy and is **not** intended for production use. + +**Use pre-bundled dev build:** + +1. Download the package for your distribution from the [releases page](https://github.com/mrdimidium/Zorian/releases/tag/dev) +1. Install via system package manager: + + ```bash + # Debian/Ubuntu + sudo dpkg -i zorian_*.deb + # Fedora + sudo dnf install zorian-*.rpm + # Arch Linux + sudo pacman -U zorian-*.pkg.tar.zst + ``` + +1. start systemd service: `sudo systemctl enable --now zorian` + +**Build from source:** + +1. Install build dependencies: + - Arch Linux: `sudo pacman -S base-devel openssl pkg-config` + - Fedora/RedHat: `sudo dnf install gcc openssl-devel pkg-config` + - Debian/Ubuntu: `sudo apt install build-essential libssl-dev pkg-config` +1. Clone and build via cargo: + + ```bash + git clone https://github.com/mrdimidium/Zorian.git && cd Zorian + + cargo build --release + + # Build linux package packages via nfpm (ihttps://nfpm.goreleaser.com/) + nfpm package -p deb --target dist/ + nfpm package -p rpm --target dist/ + nfpm package -p archlinux --target dist/ + + # Install binary manually + sudo groupadd --system zorian + sudo useradd --system --gid zorian --no-create-home --shell /usr/sbin/nologin zorian + sudo install -m 700 -o zorian ./pkg/zorian.toml /etc/ + sudo install -m 755 -o root ./pkg/zorian.service /usr/lib/systemd/system + sudo install -m 755 -o root target/release/zorian /usr/local/bin/ + ``` + +1. start systemd service: `sudo systemctl enable --now zorian` + ## License Copyright (C) 2026 Nikolay Govorov diff --git a/REUSE.toml b/REUSE.toml index 4cdd3ec..67c7f24 100644 --- a/REUSE.toml +++ b/REUSE.toml @@ -2,7 +2,6 @@ version = 1 [[annotations]] path = [ - ".github/**", ".gitignore", "CLA.md", "README.md", |