= README

== Installation

. https://github.com/nvm-sh/nvm#installation-and-update[Install `nvm`]:
+
[source,bash]
....
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
source ~/.bashrc
command -v nvm
....

. Install the latest Node LTS release:
+
[source,bash]
....
nvm install --lts
node --version
....

. Get the code of the docs and install antora packages:
+
[source,bash]
....
git clone https://github.com/BRL-CAD/docs
cd docs/

npm install
npx antora -v
....


== Build the docs

- For development: +
  `npx antora build-dev.yml`

- For the online site: +
  `CI=true npx antora build.yml`

- For the offline site:
+
[source,bash]
....
dest=/usr/local/share/doc/brlcad
rm -rf $dest
npx antora build.yml --to-dir=$dest --url=$dest
....

- To (re)generate the man pages: +
  `utils/manpages.sh`