simple-osd-daemons/README.md

54 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2020-09-13 21:26:46 +04:00
# Simple OSD daemons
A collection of simple yet configurable OSD daemons that use Freedesktop notifications to display various information about your system.
2020-09-15 22:19:27 +04:00
## Example screenshot
![](./assets/pulseaudio.png)
Taken with [mako](https://github.com/emersion/mako) as a notification daemon and IBM Plex font.
2020-09-13 21:26:46 +04:00
## Installation
### Nix
These commands will allow you to try the daemons without installing anything globally; Likely, you want to somehow install this on your system after this. How you do it depends on your setup and preferences.
`nix shell git+https://code.balsoft.ru/balsoft/simple-osd-daemons` to get all daemons. Add `#$DAEMON` to only get `$DAEMON`. If you don't use nix 3 yet, try `nix-shell https://code.balsoft.ru/balsoft/simple-osd-daemons/archive/master.tar.gz -A defaultPackage.x86_64-linux`
### Cargo
`cargo build`
2020-09-14 02:50:06 +04:00
You can also build individual daemons with `cargo build --bin simple-osd-$DAEMON` .
2020-09-13 21:26:46 +04:00
## Usage
Run the daemons you need. At this moment, none of them accept any arguments.
### Configuration
`simple-osd-daemons` follows XDG Basedir specification: configuration will be written to `$XDG_CONFIG_HOME/simple-osd/`, typically `~/.config/simple-osd/`. Each daemon has a separate configuration file in INI format, and there is also a `common` configuration file. On startup, the daemons will create their configuration files and populate them with default values if they don't exist.
2020-09-14 02:35:24 +04:00
2020-09-14 14:42:50 +04:00
## FIXME
2020-09-21 02:48:51 +04:00
1. ~~Generate `Cargo.nix` on the fly~~
2020-09-14 14:42:50 +04:00
2. Bluetooth daemon doesn't actually work, since blurz doesn't allow to get the list of connected devices
3. Need to figure out icons
2020-09-14 02:35:24 +04:00
## License
This is free and unencumbered software released into the public domain.
If you want to read more, see [LICENSE](./LICENSE)
## Contributing
If you have any issues or suggestions, shoot an email at <issues@balsoft.ru> with `[simple-osd]` in subj, or [open an issue on GitHub](https://github.com/balsoft/simple-osd-daemons/issues/new)
If you have some concrete changes and would like to share them, submit them with `git send-email` or `git request-pull` to <patches@balsoft.ru> with `simple-osd` in subj or [open a pull request](https://github.com/balsoft/simple-osd-daemons/pulls). Please note that your work will become public domain too if you do this.
***
balsoft, 2020. No rights reserved.