Skip to content

README.md

Latest commit

 

History

History
52 lines (48 loc) · 1.17 KB

README.md

File metadata and controls

52 lines (48 loc) · 1.17 KB

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

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:

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:

console:
    cmd: echo "Hello World"
building:
    use: roff
    build: main.1
tooling:
    tool: mytool troff
    use: mytool
    build: main.1

This will eventually run:

echo "Hello World"
groff main.1
troff main.1

Then compile with the command rtfm and you're good to go:

rtfm

Manual generated! You can also compile the rtfm manual with rtfm using:

cd examples
sudo rtfm # Presuming /usr/local/man/man1 exists
man rtfm

Or by just running install-man.sh.