aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCem Keylan <cem@ckyln.com>2020-12-26 02:39:36 +0300
committerCem Keylan <cem@ckyln.com>2020-12-26 03:12:25 +0300
commitd1590234d19724f14e8ba94582986963fce47267 (patch)
tree1bb6273414ef57443b3cdda21f0329b0dc8ae742 /README.md
parent06aca27d4b504ea5f42f4611fa3b44d9429bea75 (diff)
downloaddocs-d1590234d19724f14e8ba94582986963fce47267.tar.gz
docs: switch to redo build system.20201226
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 18 insertions, 7 deletions
diff --git a/README.md b/README.md
index 78a51fa..9dc1134 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,18 @@
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.
+This is the Carbs Linux documentation written with Emacs Org-mode. It can be
+viewed offline by installing the `carbs-docs` package. Distribution tarballs
+come with a prebuilt info page and plaintext pages, so neither `emacs` nor
+`texinfo` is necessary.
+
+You can view offline documentation by doing one of the following:
+
+ less /usr/share/doc/carbslinux.txt
+
+Or:
+
+ info carbslinux
There are two packages in the repository for viewing info files, `texinfo` and
`info`. The `info` package only comes with the statically linked documentation
@@ -12,10 +20,13 @@ 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`.
+
+To generate info pages from the git repository, you will need to install
+`texinfo`. For your convenience, the plaintext and texinfo files are committed
+directly on the repository, but those files are generated directly from Emacs.
git clone git://git.carbslinux.org/docs
cpt-build texinfo && cpt-install texinfo
- make
- make PREFIX=/usr install
+ redo
+ PREFIX=/usr redo install
install-info /usr/share/info/carbslinux.info /usr/share/info/dir