arisunz
/
w3panik
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Contributing

This commit is contained in:
Ariela Wenner 2018-10-11 15:48:18 -03:00
parent e367b2d5b8
commit f82858b75d
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -36,24 +36,20 @@ buffer_size=16
[COMMANDS]
# It is important that there's no spaces around the '='
#
# Note that comparisons ignore case
# Note that keywords are *not* case sensitive.
#
example=notify-send example
order66=notify-send "it is done"
```
## To Do (in urgency order):
* Clean up the code and fix potential buffer overflows
* Implement UNIX daemon-like behaviour
* Implement proper Unicode support
## Building
### Requirements
* Recent GCC version in a Linux system.
* Your basic build essentials, especifically `make`.
* Your usual build essentials, especifically `make`.
* Somewhat recent version of glibc -- we use some non-standard features.
* `linux/input.h` header which you probably have, but check for it anyways at `/usr/include/linux`.
From there, do either `make debug` or `make release`.
@ -61,6 +57,16 @@ From there, do either `make debug` or `make release`.
Unfortuately, this is Linux dependant and I don't have the time nor resources to port to other systems.
## Contributing
Feel free open an issue. Or send me a patch. While doing so, please try to adhere to the used coding style.
### To Do (in urgency order):
* Clean up the code and fix potential buffer overflows
* Implement UNIX daemon-like behaviour
* Implement proper Unicode support
## License
This project is licensed under the GNU GPLv3. See the [LICENSE](LICENSE.md) for details.