rtfm v0.5.1
Read the Formidable Manual
It's a dash/docset reader with built in documentation for Crystal and GTK APIs. It's written in Crystal using GTK4 bindings.
![](https://github.com/hugopl/rtfm/raw/main/./screenshots/v0.4.1.png)
Tasks needed to be done before I ask anyone to use this:
- Refactor Fzy API to remove some bad and slow stuff I wrote just to have something working.
- Add UI to download docset.
- Have a nice set of icons.
- Have button/shortcut to enable/disable fuzzy search.
- Ubuntu package.
Installation
ArchLinux
There's a AUR package, it's named gnome-rtfm
because there's already a rtfm
package there for another project.
yay -S gnome-rtfm
Ubuntu
Waiting for you to submit a package 😉️.
Nix
The easiest way to install package
Install nix
package manager:
sh <(curl -L https://nixos.org/nix/install) --daemon
Add unstable
channel:
nix-channel --add https://nixos.org/channels/nixpkgs-unstable unstable
nix-channel --update
Install rtfm
package:
nix-env -iA unstable.rtfm
Run:
rtfm
The best way to install package
If you want the best experience and all the features of nix, you need to follow a few steps described in this repository.
Flatpak
Not on flathub yet, but you can build the package by doing:
$ flatpak-builder ./build ./data/io.github.hugopl.rtfm.json --user --install --force-clean
$ flatpak run io.github.hugopl.rtfm
Compiling from source
Dependencies:
- Crystal compiler.
- Shards dependency manager.
- SQLite3.
- GTK4
- GTK Webkit-6.0
- GObject-introspection packages for all GTK related dependencies.
- Offline crystal api documentation for Crystal docset generation.
- Offline Gtk api documentation for Gtk4, Gdk4, Gsk4, libAdwaita and Pango libraries for GTK4 libraries docset generation.
$ make
$ sudo make install
Then you need to run some commands to let Gnome Shell update the application cache and start show Rtfm, but if you don't remember these commands, just reinstall some Gnome application like gnome-calculator and it's done 😅️.
You can uninstall it later with:
$ sudo make uninstall
Contributing
- Fork it (https://github.com/hugopl/rtfm/fork)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request
Contributors
- Hugo Parente Lima - creator and maintainer
rtfm
- 29
- 4
- 3
- 0
- 3
- 12 days ago
- June 27, 2023
MIT License
Sat, 07 Sep 2024 19:07:26 GMT