diff options
| author | Cem Keylan <cem@ckyln.com> | 2020-09-14 22:06:23 +0300 |
|---|---|---|
| committer | Cem Keylan <cem@ckyln.com> | 2020-09-14 22:06:23 +0300 |
| commit | 0013145861319f921ae2fce593722b29a41e325c (patch) | |
| tree | ee62d1f6c72ad50fa0d01263efe59e223e9d6a63 /README.md | |
| parent | eb6cce052f4f559b20f751dab2ea17e5e69d8afe (diff) | |
| download | docs-0013145861319f921ae2fce593722b29a41e325c.tar.gz | |
move README to README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..78a51fa --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +Carbs Linux User Manual +-------------------------------------------------------------------------------- + +This is the Carbs Linux documentation written with Texinfo. It can be viewed +offline by installing the `carbs-docs` package. Distribution tarballs comes with +prebuilt info and plaintext pages, so they don't depend on the `texinfo` +package. + +There are two packages in the repository for viewing info files, `texinfo` and +`info`. The `info` package only comes with the statically linked documentation +reader, so you don't need `perl` to install it. + + cpt-build info carbs-docs + +To generate pages from the git repository you will need to install `texinfo`. + + git clone git://git.carbslinux.org/docs + cpt-build texinfo && cpt-install texinfo + make + make PREFIX=/usr install + install-info /usr/share/info/carbslinux.info /usr/share/info/dir |