devex: manage devtools in a project-local subdirectory + cleanup README (#829)

This commit is contained in:
Christian Schwarz
2024-10-21 21:36:34 +02:00
committed by GitHub
parent 908807bd59
commit 20abaa2e7f
15 changed files with 144 additions and 265 deletions

View File

@@ -11,10 +11,9 @@ Installation
.. toctree::
installation/user-privileges
installation/packages
installation/apt-repos
installation/rpm-repos
installation/compile-from-source
installation/user-privileges
installation/freebsd-jail-with-iocage
installation/what-next

View File

@@ -1,44 +0,0 @@
.. _binary releases: https://github.com/zrepl/zrepl/releases
.. _installation-compile-from-source:
Compile From Source
~~~~~~~~~~~~~~~~~~~
Producing a release requires **Go 1.11** or newer and **Python 3** + **pip3** + ``docs/requirements.txt`` for the Sphinx documentation.
A tutorial to install Go is available over at `golang.org <https://golang.org/doc/install>`_.
Python and pip3 should probably be installed via your distro's package manager.
::
cd to/your/zrepl/checkout
python3 -m venv3
source venv3/bin/activate
./lazy.sh devsetup
make release
# build artifacts are available in ./artifacts/release
The Python venv is used for the documentation build dependencies.
If you just want to build the zrepl binary, leave it out and use `./lazy.sh godep` instead.
Alternatively, you can use the Docker build process:
it is used to produce the official zrepl `binary releases`_
and serves as a reference for build dependencies and procedure:
::
cd to/your/zrepl/checkout
# make sure your user has access to the docker socket
make release-docker
# if you want .deb or .rpm packages, invoke the follwoing
# targets _after_ you invoked release-docker
make deb-docker
make rpm-docker
# build artifacts are available in ./artifacts/release
# packages are available in ./artifacts
.. NOTE::
It is your job to install the built binary in the zrepl users's ``$PATH``, e.g. ``/usr/local/bin/zrepl``.
Otherwise, the examples in the :ref:`quick-start guides <quickstart-toc>` may need to be adjusted.

View File

@@ -16,10 +16,13 @@ The following list may be incomplete, feel free to submit a PR with an update:
* - OS / Distro
- Install Command
- Link
* - any
- Statically linked binaries.
- `Official GitHub releases <binary releases_>`_
* - FreeBSD
- ``pkg install zrepl``
- `<https://www.freshports.org/sysutils/zrepl/>`_
:ref:`installation-freebsd-jail-with-iocage`
* - FreeNAS
-
@@ -30,7 +33,7 @@ The following list may be incomplete, feel free to submit a PR with an update:
* - Arch Linux
- ``yay install zrepl``
- Available on `AUR <https://aur.archlinux.org/packages/zrepl>`_
* - Fedora, CentOS, RHEL, OpenSUSE
* - Fedora / RHEL / OpenSUSE
- ``dnf install zrepl``
- :ref:`RPM repository config <installation-rpm-repos>`
* - Debian + Ubuntu
@@ -42,6 +45,6 @@ The following list may be incomplete, feel free to submit a PR with an update:
* - Void Linux
- ``xbps-install zrepl``
- Available since `a88a2a4 <https://github.com/void-linux/void-packages/commit/a88a2a4d7bf56072dadf61ab56b8424e39155890>`_
* - Others
-
- Use `binary releases`_ or build from source.
* - any
- Build from source
- :repomasterlink:`README.md`.