cromer/tuf-manager
1
0
Fork 0
Code Issues Pull Requests Releases 8 Wiki Activity

update readme

Browse Source
This commit is contained in:
Chris Cromer 2020-08-06 19:25:03 -04:00
parent b01c88cdc5
commit 95d084883f
Signed by: cromer
GPG Key ID: 39CC813FF3C8708A
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,6 +1,7 @@
# TUF Manager # TUF Manager
## License ## License
[3-Clause BSD License](LICENSE) [3-Clause BSD License](LICENSE)
## Screenshots ## Screenshots
@ -10,6 +11,7 @@
<img src="screenshot/tuf-cli.png" /> <img src="screenshot/tuf-cli.png" />
## Build requirements ## Build requirements
To build TUF Manager the following is needed: To build TUF Manager the following is needed:
- vala - vala
@ -30,9 +32,11 @@ This software will only work if using the [faustus](https://github.com/hackbnw/f
- valadocs - valadocs
Build TUF Manager's vala documentation. Build TUF Manager's vala documentation.
- valadocs-deps - valadocs-deps
Build external valadocs that TUF Manager utilizes and calls. Build external valadocs that TUF Manager utilizes and calls.
- build-cli - build-cli
Build the cli interface. Build the cli interface.
@ -40,11 +44,29 @@ Build the cli interface.
- build-gui - build-gui
Build the gui interface. Build the gui interface.
- always-authenticated - always-authenticated
Authentication is not required to use the TUF Server that runs in the background as a daemon, if this is set to false polkit is used for authentication. Setting this to false is more secure, but also makes things like auto restore of settings on login impossible to do without a password. Authentication is not required to use the TUF Server that runs in the background as a daemon, if this is set to false polkit is used for authentication. Setting this to false is more secure, but also makes things like auto restore of settings on login impossible to do without a password.
- openrc
Install an OpenRC init script. Ff this option is not set, the init script is still generated during build, just not installed.
- runit
Install a runit init script. If this option is not set, the init script is still generated during build, just not installed.
- s6
Install n s6 init scripts. If this option is not set, the init scripts are still generated during build, just not installed.
- system
Install a systemd unit. If this option is not set, the unit is still generated during build, just not installed.
## Usage ## Usage
There are 2 programs and 1 daemon supplied by TUF Manager. There are 2 programs and 1 daemon supplied by TUF Manager.
- tuf-cli - tuf-cli
@ -64,4 +86,3 @@ This is the daemon that runs in the background and handles all requests from bot
- Status bar icon that allows control of the notebook - Status bar icon that allows control of the notebook
- Notifications of fan mode change via status bar - Notifications of fan mode change via status bar
- Restore last known settings on login via status bar icon - Restore last known settings on login via status bar icon
- Service scripts for various init systems instead of relying on dbus activation