ExternalVendorCode/ZeroTierOne
1
0
Fork 0
mirror of https://github.com/zerotier/ZeroTierOne.git synced 2024-12-19 21:17:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Adam Ierymenko 2016-06-29 09:45:02 -07:00
parent 0410fd4824
commit 928c625e2c
3 changed files with 28 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/README.md
View File

@ -1,4 +1,6 @@
Manual Pages and Other Documentation Manual Pages and Other Documentation
===== =====
Use "./build.sh" to build the manual pages. You'll need NodeJS and npm installed. Use "./build.sh" to build the manual pages.
You'll need either NodeJS/npm installed (script will then automatically install the npm *marked-man* package) or */usr/bin/ronn*. The latter is a Ruby program packaged on some distributions as *rubygem-ronn* or *ruby-ronn* or installable as *gem install ronn*. The Node *marked-man* package and *ronn* from rubygems are two roughly equivalent alternatives for compiling MarkDown into roff/man format.

25
doc/build.sh
View File

@ -9,24 +9,29 @@ fi
rm -f *.1 *.2 *.8 rm -f *.1 *.2 *.8
if [ -e /usr/bin/ronn -o -e /usr/local/bin/ronn ]; then if [ -e /usr/bin/ronn -o -e /usr/local/bin/ronn ]; then
# Use 'ronn' which is available as a package on many distros including Debian
ronn -r zerotier-cli.1.md ronn -r zerotier-cli.1.md
ronn -r zerotier-idtool.1.md ronn -r zerotier-idtool.1.md
ronn -r zerotier-one.8.md ronn -r zerotier-one.8.md
else else
if [ ! -f /usr/bin/node -a ! -f /usr/bin/nodejs ]; then # Use 'marked-man' from npm
echo 'Unable to build man pages: no /usr/bin/ronn or /usr/bin/node / nodejs!' NODE=/usr/bin/node
exit 0 if [ ! -e $NODE ]; then
if [ -e /usr/bin/nodejs ]; then
NODE=/usr/bin/nodejs
elif [ -e /usr/local/bin/node ]; then
NODE=/usr/local/bin/node
elif [ -e /usr/local/bin/nodejs ]; then
NODE=/usr/local/bin/nodejs
else
echo 'Unable to find ronn or node/npm -- cannot build man pages!'
exit 1
fi
fi fi
if [ ! -f node_modules/marked-man/bin/marked-man ]; then if [ ! -f node_modules/marked-man/bin/marked-man ]; then
echo 'Installing MarkDown to ROFF converter...' echo 'Installing npm package "marked-man" -- MarkDown to ROFF converter...'
npm install marked-man npm install marked-man
echo
fi
NODE=/usr/bin/node
if [ -e /usr/bin/nodejs ]; then
NODE=/usr/bin/nodejs
fi fi
$NODE node_modules/marked-man/bin/marked-man zerotier-cli.1.md >zerotier-cli.1 $NODE node_modules/marked-man/bin/marked-man zerotier-cli.1.md >zerotier-cli.1

11
ext/README.md
View File

@ -1 +1,10 @@
The ext/ folder contains third party code, drivers, installation support files, etc. Miscellaneous Stuff
======
This subfolder contains:
* Bundled third party libraries that are compiled into the binary on platforms and Linux distributions where they are not available on the system.
* Pre-compiled binaries for some platforms, such as pre-built and signed drivers for Mac and Windows.
* Miscellaneous files used by installers and packages on various platform targets.