Whyblocked reminds you why you blocked someone.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 3.8KB

1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108
  1. **Whyblocked** allows you to store the reason why you blocked someone, along
  2. with "receipts", URLs to the posts that led you to block them.
  3. It has a Qt-interface and uses an SQLite-database.
  4. ![Screenshot Qt interface](https://doc.schlomp.space/whyblocked/whyblocked_screenshot.png)
  5. ## Usage
  6. Run `whyblocked`. You can also start it from the menu of your desktop
  7. environment.
  8. ## Install
  9. ### Packages
  10. Every [release](https://schlomp.space/tastytea/whyblocked/releases) includes
  11. a .deb-package, an .rpm-package and a .tar.gz-package with precompiled binaries
  12. for x86_64(amd64) ([more info](https://schlomp.space/tastytea/whyblocked/wiki/Binary-Packages)). These are automatically built and not tested. You can install
  13. them with `dpkg -i` or `rpm -i`, respectively. The packages are signed with the
  14. PGP key [242E5AC4DA587BF9](https://tastytea.de/tastytea_autosign.asc)
  15. (Fingerprint: `F730 1ADF C9ED 2624 48C4 2B64 242E 5AC4 DA58 7BF9`).
  16. Gentoo ebuilds are available via my
  17. [repository](https://schlomp.space/tastytea/overlay).
  18. ### From source
  19. #### Dependencies
  20. * C++ compiler (tested: [gcc](https://gcc.gnu.org/) 6/7/8,
  21. [clang](https://llvm.org/) 3/5/6)
  22. * [cmake](https://cmake.org/) (at least 3.2)
  23. * [vsqlite++](http://vsqlite.virtuosic-bytes.com/) (tested: 0.3)
  24. * [libxdg-basedir](http://repo.or.cz/w/libxdg-basedir.git) (tested: 1.2)
  25. * [qtcore](https://www.qt.io/) (tested: 5.11/5.5)
  26. * [qtwidgets](https://www.qt.io/) (tested: 5.11/5.5)
  27. * [libconfig++](https://github.com/hyperrealm/libconfig) (tested: 1.5)
  28. * Optional
  29. * Translations: [lupdate & lrelease](http://doc.qt.io/qt-5/linguist-manager.html) (tested: 5.11/5.5)
  30. * Manpage: [asciidoc](http://asciidoc.org/) (tested: 8.6)
  31. #### Get sourcecode
  32. Download the current
  33. [release](https://schlomp.space/tastytea/whyblocked/releases) and copy
  34. [xdgcfg](https://schlomp.space/tastytea/xdgcfg) into `xdgcfg/`.
  35. If you clone from git, be sure to `git submodule init` and
  36. `git submodule update` afterwards. See the [submodules article in the git book]
  37. (https://git-scm.com/book/en/v2/Git-Tools-Submodules#_cloning_submodules) for
  38. further info.
  39. #### Compile
  40. ```SH
  41. mkdir build
  42. cd build
  43. cmake ..
  44. make
  45. make install
  46. ```
  47. cmake options:
  48. * `-DCMAKE_BUILD_TYPE=Debug` for a debug build
  49. * `-DWITH_TRANSLATIONS=NO` to not compile translations
  50. * `-DWITH_MAN=NO` to not compile the manpage
  51. * One of:
  52. * `-DWITH_DEB=YES` if you want to be able to generate a deb-package
  53. * `-DWITH_RPM=YES` if you want to be able to generate an rpm-package
  54. ## Contributing
  55. Contributions are always welcome. You can submit them as pull requests or via
  56. email to `tastytea`@`tastytea.de`.
  57. ### Translations
  58. To start a new translation, go to `translations/` and copy `whyblocked_en.ts` to
  59. a file [appropriate](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
  60. for the new language. If you want to translate to french for example, that file
  61. name would be `whyblocked_fr.ts`.
  62. Use [Linguist](http://doc.qt.io/qt-5/qtlinguist-index.html) to edit the
  63. `.ts`-files.
  64. ## Bugs
  65. Please report them on the
  66. [issue tracker](https://schlomp.space/tastytea/whyblocked/issues) or to
  67. `tastytea`@`tastytea.de`.
  68. ## Licence & Copyright
  69. ```PLAIN
  70. Copyright © 2018 tastytea <tastytea@tastytea.de>.
  71. License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
  72. This program comes with ABSOLUTELY NO WARRANTY. This is free software,
  73. and you are welcome to redistribute it under certain conditions.
  74. ```
  75. The icon is derived from the icons `messagebox critical` and `help` of the
  76. [Gartoon icon theme](https://commons.wikimedia.org/wiki/Gartoon_icons). The
  77. original authors were Zeus, Patrick Yavitz and La Mula Francis, who released
  78. them under the terms of the
  79. [GPL2+](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html) and
  80. [DSL](http://www.fsf.org/licensing/licenses/dsl.html). The new icon is released
  81. under the same terms.