https://github.com/callmesalmon/rtfm
Read The Fucking Manual - A documentation tool for when you really need to read the fucking manual.
https://github.com/callmesalmon/rtfm
Last synced: 5 months ago
JSON representation
Read The Fucking Manual - A documentation tool for when you really need to read the fucking manual.
- Host: GitHub
- URL: https://github.com/callmesalmon/rtfm
- Owner: callmesalmon
- License: apache-2.0
- Created: 2024-12-30T19:06:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-12T09:04:57.000Z (9 months ago)
- Last Synced: 2025-04-12T10:22:47.937Z (9 months ago)
- Language: Python
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# RTFM - Read The Fucking Manual
RTFM is a manual generation tool for when someone on the archlinux website tells you to "rtfm".
It is the shittiest manual generation tool around, and might also be written in python, so that's
even worse.
## Install
```console
git clone https://github.com/callmesalmon/rtfm
cd rtfm
./install.sh
```
## How to
RTFM operates by using a configuration file, kind of like `make`!
The configuration file is called `rtfm.yml`, so we can start of
with creating that:
```console
touch rtfm.yml
```
Open it. RTFM operates by using a YAML-like configuration (tough I built this parser from
scratch, so it's much worse than say, libyaml3). This is an example:
```yaml
console:
cmd: echo "Hello World"
building:
use: roff
build: main.1
tooling:
tool: mytool troff
use: mytool
build: main.1
```
This will eventually run:
```console
echo "Hello World"
groff main.1
troff main.1
```
Then compile with the command `rtfm` and you're good to go:
```console
rtfm
```
Manual generated! You can also compile the rtfm manual with rtfm
using:
```sh
cd examples
sudo rtfm # Presuming /usr/local/man/man1 exists
man rtfm
```
Or by just running ``install-man.sh``.