tuf-manager/README.md

# TUF Manager

## License
[3-Clause BSD License](LICENSE)

## Screenshots

<img src="screenshot/tuf-gui.png" /> 

<img src="screenshot/tuf-cli.png" /> 

## Build requirements
To build TUF Manager the following is needed:

- vala
- valadoc
- glib
- gtk3
- dbus
- polkit
- polkit-gobject
- gmodule-export

## Other requirements

This software will only work if using the [faustus](https://github.com/hackbnw/faustus) driver module.

## Build options

- valadocs

Build TUF Manager's vala documentation.
- valadocs-deps

Build external valadocs that TUF Manager utilizes and calls.
- build-cli

Build the cli interface.

- build-gui

Build the gui interface.
- 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.

## Usage
There are 2 programs and 1 daemon supplied by TUF Manager.

- tuf-cli

This allows controlling the TUF laptop functions via command line interface.
- tuf-gui

This supplies a graphical interface to control the TUF laptop.
- tuf-server

This is the daemon that runs in the background and handles all requests from both tuf-cli and tuf-gui.

## Future plans

- Manpage
- Config options for both tuf-gui and tuf-cli
- Status bar icon that allows control of the notebook
- Notifications of fan mode change via status bar
- Restore last known settings on login via status bar icon
- Service scripts for various init systems instead of relying on dbus activation
initial commit 2020-08-04 23:09:05 -04:00			`# TUF Manager`

			`## License`
			`[3-Clause BSD License](LICENSE)`

add screenshots 2020-08-04 23:30:07 -04:00			`## Screenshots`

			`<img src="screenshot/tuf-gui.png" />`

			`<img src="screenshot/tuf-cli.png" />`

initial commit 2020-08-04 23:09:05 -04:00			`## Build requirements`
			`To build TUF Manager the following is needed:`

			`- vala`
			`- valadoc`
			`- glib`
			`- gtk3`
			`- dbus`
			`- polkit`
			`- polkit-gobject`
			`- gmodule-export`

update readme 2020-08-04 23:16:10 -04:00			`## Other requirements`

			`This software will only work if using the [faustus](https://github.com/hackbnw/faustus) driver module.`

initial commit 2020-08-04 23:09:05 -04:00			`## Build options`

			`- valadocs`

			`Build TUF Manager's vala documentation.`
			`- valadocs-deps`

			`Build external valadocs that TUF Manager utilizes and calls.`
update readme 2020-08-04 23:16:10 -04:00			`- build-cli`

			`Build the cli interface.`

			`- build-gui`

			`Build the gui interface.`
initial commit 2020-08-04 23:09:05 -04:00			`- 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.`

			`## Usage`
			`There are 2 programs and 1 daemon supplied by TUF Manager.`

			`- tuf-cli`

			`This allows controlling the TUF laptop functions via command line interface.`
			`- tuf-gui`

			`This supplies a graphical interface to control the TUF laptop.`
			`- tuf-server`

			`This is the daemon that runs in the background and handles all requests from both tuf-cli and tuf-gui.`

			`## Future plans`

			`- Manpage`
			`- Config options for both tuf-gui and tuf-cli`
			`- Status bar icon that allows control of the notebook`
			`- Notifications of fan mode change via status bar`
			`- Restore last known settings on login via status bar icon`
			`- Service scripts for various init systems instead of relying on dbus activation`