Skip to content

Commit

Permalink
A few additions to the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
krtab committed Oct 29, 2024
1 parent bf96229 commit 61f478d
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ Agnos leverages let's encrypt capability to follow DNS `NS` records. It requires
1. [Installation](#installation)
1. [Released binary](#released-binary)
1. [Archlinux AUR package](#archlinux-aur-package)
1. [Packaging on other systems](#packaging-on-other-systems)
1. [Building](#building)
1. [Setting capabilities to not run agnos as root](#setting-capabilities-to-not-run-agnos-as-root)
1. [Usage](#usage)
Expand All @@ -70,6 +71,7 @@ Agnos leverages let's encrypt capability to follow DNS `NS` records. It requires
1. [Systemd units](#systemd-units)
1. [Developers](#developers)
1. [Integration testing](#integration-testing)
1. [User feedback requested](#user-feedback-requested)

<!-- /TOC -->

Expand All @@ -85,6 +87,10 @@ Pre-compiled binaries for Linux/amd64 are available for every tagged [release](h

Agnos is available in the [AUR](https://aur.archlinux.org/packages/agnos). You can install it using: `yay -S agnos`.

## Packaging on other systems

If you have packaged agnos for another system, feel free to open a PR to add it to the list.

## Building

Agnos is written in Rust. To build it you will need to have the rust toolchain installed, in a version greater or equal to 1.65.0. On most distributions, this should be done using [rustup](https://rustup.rs).
Expand Down Expand Up @@ -234,4 +240,9 @@ Build using usual `cargo` commands.

## Integration testing

Integration testing is done using nix-shell. Launch it with `nix-shell integration-testing/shell.nix --pure --run agnos-test-script`
Integration testing is done using nix-shell. Launch it with `nix-shell integration-testing/shell.nix --pure --run agnos-test-script`

# User feedback requested

If you are using agnos, please consider telling me about your user experience here: https://github.com/krtab/agnos/issues/62

0 comments on commit 61f478d

Please sign in to comment.