From a76a602886ffdd0ac3b770021f72b88251f0c935 Mon Sep 17 00:00:00 2001 From: sw1tchbl4d3 Date: Wed, 9 Feb 2022 20:16:13 +0100 Subject: [PATCH] Clarify build instructions in README --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8c404e7..a492cc2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # RootDO [![AUR](https://img.shields.io/aur/version/rdo.svg)](https://aur.archlinux.org/packages/rdo/) -This little "project" aims to be a very slim alternative to both sudo and doas. +This project aims to be a very slim alternative to both sudo and doas. ### Installation If you are on Arch Linux, you can download the package via the [AUR](https://aur.archlinux.org/packages/rdo/). -If you are using any other linux distro, you can build it yourself by following these instructions: +If you are using any other linux distro, or want to build it yourself, you will first need to install either `libbsd` or `libbsd-dev`, depending on how your package manager calls it. + +Then, you can clone and build rdo with the following set of commands: ```sh git clone https://codeberg.org/sw1tchbl4d3/rdo @@ -18,9 +20,9 @@ sudo make install After that, you'll have to configure rdo to allow you to use it. To do this, edit `/etc/rdo.conf`, and set the username variable to your own. -After that you're good to go! +Then you're good to go! -And to uninstall: +To uninstall: ```sh sudo make uninstall ``` @@ -42,9 +44,6 @@ session_ttl=5 - `wrong_pw_sleep`: The amount of milliseconds to sleep at a wrong password attempt. Must be a positive integer. Set to 0 to disable. - `session_ttl`: The amount of minutes a session lasts. Must be a positive integer. Set to 0 to disable. -### Dependencies -- `libbsd` - ### Benchmarks The benchmark: Execute `whoami` (GNU coreutils 8.32) 1000 times.