README.asciidoc 2.2 KB

  1. = gonk
  2. apiote <>
  3. :toc:
  4. terminal reader for honk (
  5. == setup
  6. create file `account` in `XDG_CONFIG_HOME/gonk` (`$HOME/.config/gonk`) with three lines
  7. ```
  8. username = {username}
  9. password = {password}
  10. server = {server}
  11. ```
  12. replace {variables} with what they should be. server should be just host name -- without `http(s)://` in front
  13. == run
  14. run `gonk` to show honks with colours or `gonk -t` to show them without colours.
  15. == contribute
  16. this project is finished; no more functions will be implemented; all feature requests will be ignored.
  17. this project uses The Code of Merit, which is available as CODE_OF_CONDUCT file.
  18. fixes and patches are welcome; please send them to `` using `git send-email`. they must include a sign-off to certify agreement to[developer certificate of origin].
  19. all communication—questions, bugs, etc.—should go through the mailing list available at ``. note that all communication will be made public at
  20. == mirrors
  21. the canonical repository for this project is it’s mirrored at
  22. mirrors exist solely for the sake of the code and any additional functions provided by third-party services (including but not limited to issues and pull requests) will not be used and will be ignored.
  23. == license
  24. gonk is adapted from honk examples
  25. ```
  26. Copyright (c) 2019 Ted Unangst <>
  27. ```
  28. GPL applies (see LICENSE)
  29. ```
  30. gonk -- honk reader
  31. Copyright (C) 2020 apiote
  32. This program is free software: you can redistribute it and/or modify
  33. it under the terms of the GNU General Public License as published by
  34. the Free Software Foundation, either version 3 of the License, or
  35. (at your option) any later version.
  36. This program is distributed in the hope that it will be useful,
  37. but WITHOUT ANY WARRANTY; without even the implied warranty of
  39. GNU General Public License for more details.
  40. You should have received a copy of the GNU General Public License
  41. along with this program. If not, see <>.
  42. ```