Gnome dash docset documentation reader written in Crystal
MIT License
It's a dash/docset reader with built in documentation for Crystal and GTK APIs. It's written in Crystal using GTK4 bindings.
Tasks needed to be done before I ask anyone to use this:
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
Waiting for you to submit a 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
If you want the best experience and all the features of nix, you need to follow a few steps described in this repository.
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
Dependencies:
$ 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
git checkout -b my-new-feature
)git commit -am 'Add some feature'
)git push origin my-new-feature
)