diff options
| author | Cem Keylan <cem@ckyln.com> | 2020-09-14 22:05:55 +0300 |
|---|---|---|
| committer | Cem Keylan <cem@ckyln.com> | 2020-09-14 22:05:55 +0300 |
| commit | eb6cce052f4f559b20f751dab2ea17e5e69d8afe (patch) | |
| tree | cc342c5500747463ac5e8e936e73ed1cccbe20b7 | |
| parent | 2168b81e551c35894eadf38077f67cbc4f52d567 (diff) | |
| download | docs-eb6cce052f4f559b20f751dab2ea17e5e69d8afe.tar.gz | |
update README
| -rw-r--r-- | README | 27 |
1 files changed, 18 insertions, 9 deletions
@@ -1,12 +1,21 @@ -CARBS LINUX DOCUMENTATION -================================================================================ +Carbs Linux User Manual +-------------------------------------------------------------------------------- -This is the source of offline documentation for Carbs Linux. It is a part of the -'core' repository and can be obtained by installing it with kiss. +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. - +--------------------------------------------------------------------------+ - | $ kiss b carbs-docs | - | $ kiss i carbs-docs | - +--------------------------------------------------------------------------+ +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. -This documentation isn't complete yet, you can help by expanding 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 |