{"id":15808750,"url":"https://github.com/hugopl/rtfm","last_synced_at":"2025-04-15T17:46:16.397Z","repository":{"id":177728278,"uuid":"659303905","full_name":"hugopl/rtfm","owner":"hugopl","description":"Gnome dash docset documentation reader written in Crystal","archived":false,"fork":false,"pushed_at":"2024-08-26T16:18:43.000Z","size":1123,"stargazers_count":29,"open_issues_count":3,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-06T03:06:02.079Z","etag":null,"topics":["crystal","dash","docset","documentation","gtk4","reader"],"latest_commit_sha":null,"homepage":"","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hugopl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"hugopl"}},"created_at":"2023-06-27T14:44:22.000Z","updated_at":"2024-08-26T16:18:34.000Z","dependencies_parsed_at":"2023-12-15T13:25:53.781Z","dependency_job_id":"4f30bf06-68e5-4d84-aa61-51294c365bb5","html_url":"https://github.com/hugopl/rtfm","commit_stats":null,"previous_names":["hugopl/rtfm"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugopl%2Frtfm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugopl%2Frtfm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugopl%2Frtfm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hugopl%2Frtfm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hugopl","download_url":"https://codeload.github.com/hugopl/rtfm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249123909,"owners_count":21216587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["crystal","dash","docset","documentation","gtk4","reader"],"created_at":"2024-10-05T03:06:29.455Z","updated_at":"2025-04-15T17:46:16.382Z","avatar_url":"https://github.com/hugopl.png","language":"Crystal","funding_links":["https://github.com/sponsors/hugopl"],"categories":[],"sub_categories":[],"readme":"![AUR Version](https://img.shields.io/aur/version/gnome-rtfm)\n\n# Read the Formidable Manual\n\nIt's a dash/docset reader with built in documentation for Crystal and GTK\nAPIs. It's written in [Crystal](https://crystal-lang.org/) using\n[GTK4 bindings](https://github.com/hugopl/gtk4.cr).\n\n\u003cimg align=\"center\" src=\"./screenshots/v0.4.1.png\" /\u003e\n\nTasks needed to be done before I ask anyone to use this:\n\n- [ ] Refactor Fzy API to remove some bad and slow stuff I wrote just to have something working.\n- [ ] Add UI to download docset.\n- [ ] Have a nice set of icons.\n- [ ] Have button/shortcut to enable/disable fuzzy search.\n- [ ] Ubuntu package.\n\n## Installation\n\n## ArchLinux\n\nThere's a AUR package, it's named `gnome-rtfm` because there's already a `rtfm` package there for another project.\n\n```\nyay -S gnome-rtfm\n```\n\n## Ubuntu\n\nWaiting for you to submit a package 😉️.\n\n## Nix\n### The easiest way to install package\n\nInstall `nix` package manager:\n```bash\nsh \u003c(curl -L https://nixos.org/nix/install) --daemon\n```\n\nAdd `unstable` channel:\n```bash\nnix-channel --add https://nixos.org/channels/nixpkgs-unstable unstable\nnix-channel --update\n```\nInstall `rtfm` package:\n```bash\nnix-env -iA unstable.rtfm\n```\nRun:\n```bash\nrtfm\n```\n### The best way to install package\nIf you want the best experience and all the features of nix, you need to follow a few steps described in [this](https://github.com/sund3RRR/nix-on-generic-linux) repository.\n\n## Flatpak\n\nNot on flathub yet, but you can build the package by doing:\n\n```\n$ flatpak-builder ./build ./data/io.github.hugopl.rtfm.json --user --install --force-clean\n$ flatpak run io.github.hugopl.rtfm\n```\n\n## Compiling from source\n\nDependencies:\n\n- [Crystal compiler](https://github.com/crystal-lang/crystal).\n- [Shards dependency manager](https://github.com/crystal-lang/shards).\n- [SQLite3](https://sqlite.org/index.html).\n- [GTK4](https://www.gtk.org/)\n- [GTK Webkit-6.0](https://webkitgtk.org/)\n- [GObject-introspection](https://gi.readthedocs.io/en/latest/) packages for all GTK related dependencies.\n- Offline crystal api documentation for Crystal docset generation.\n- Offline Gtk api documentation for Gtk4, Gdk4, Gsk4, libAdwaita and Pango libraries for GTK4 libraries docset generation.\n\n```\n$ make\n$ sudo make install\n```\n\nThen you need to run some commands to let Gnome Shell update the application cache and start show Rtfm, but\nif you don't remember these commands, just reinstall some Gnome application like gnome-calculator and it's done 😅️.\n\nYou can uninstall it later with:\n\n```\n$ sudo make uninstall\n```\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/hugopl/rtfm/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n\n## Contributors\n\n- [Hugo Parente Lima](https://github.com/hugopl) - creator and maintainer\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugopl%2Frtfm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhugopl%2Frtfm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhugopl%2Frtfm/lists"}