Clarify build instructions in README

This commit is contained in:
sw1tchbl4d3 2022-02-09 20:16:13 +01:00
parent 6b6d607ea6
commit a76a602886

View file

@ -1,12 +1,14 @@
# RootDO [![AUR](https://img.shields.io/aur/version/rdo.svg)](https://aur.archlinux.org/packages/rdo/) # 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 ### Installation
If you are on Arch Linux, you can download the package via the [AUR](https://aur.archlinux.org/packages/rdo/). 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 ```sh
git clone https://codeberg.org/sw1tchbl4d3/rdo 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. 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. 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 ```sh
sudo make uninstall 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. - `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. - `session_ttl`: The amount of minutes a session lasts. Must be a positive integer. Set to 0 to disable.
### Dependencies
- `libbsd`
### Benchmarks ### Benchmarks
The benchmark: Execute `whoami` (GNU coreutils 8.32) 1000 times. The benchmark: Execute `whoami` (GNU coreutils 8.32) 1000 times.