aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 78a51fa26d9867603d5fd9c4d68b27f8c94aebc0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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