Hello All,

This is a quick *Nix How-to for Installing AsciiDoc. A Windows How-To
will be available in the next few days. It installs AsciiDoc to the
$USER account rather than system wide. There are numerous reasons why we
should do this, which will be detailed in the quick-reference guide.

* My workstation is Ubuntu 14.04-Dev. Ubuntu uses Bash and apt-get for
the shell and package manager respectively. If your distribution uses a
different shell or pkg manager, adjust commands accordingly. While
detailed, this How-To should take =< 10 minutes to install && test build
WSJT-X User Guide.

NOTE: For developers with commit privileges, in the TEST & BUILD
section, you can use your standard method of pulling the repo if
desired.

# DEPENDENCIES
* For WSJT-X Documentation, 4 packages are required:
- Python ==> Installed by default on most systems
- Mercurial ==> vcs used with AsciiDoc
- Source highlight ==> syntax highlighting
- Subversion ==> for repository interaction

* All commands are performed in a terminal, Ctrl+Alt+T in Ubuntu.
* If your shell is Bash, you can Copy & Paste most commands directly

# UPDATE SYSTEM FIRST
sudo apt-get update && sudo apt-get upgrade


## INSTALL DEPS
sudo apt-get install mercurial source-highlight subversion

* Check hg, python, subversion and source highlight are installed
hg --version
svn --version
python -V
source-highlight --version

Note: If any package check returns with an error, resolve before
continuing!!.


## CHECK for SYSTEM-WIDE AsciiDoc INSTALLATION
asciidoc --version

If it returns a version number:
sudo apt-get purge asciidoc


## SETUP ENVIRONMENT
* Add Directories and source profiles
mkdir $HOME/bin
source ~/.bashrc && source ~/.profile

* Check $HOME/bin is in your $PATH
echo $PATH

Note:
- You may have to log out and back in for the addition to take place.
- If need be, add the following to your shell profile, then source or
log out / back in:

if [ -d "$HOME/bin" ]
then
  PATH="$HOME/bin:$PATH"
fi

## DOWNLOAD && CONFIGURE ASCIIDOC BINARY
cd ~/bin
hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9
cd asciidoc-8.6.9 && hg pull && hg update && cd ..
ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc
asciidoc --version

Returns: asciidoc 8.6.9

That's It !!

## POST INSTALL WSJT-X DOCS BUILD
* cd to where you want the docs. I use ~/Projects/documentation/wsjtx
cd ~/Projects/documentation/wsjtx

* Note: This pulls "just" the Documentation Tree, without History 
svn export svn://svn.berlios.de/wsjt/branches/wsjtx/doc
cd ./doc
./build-doc.sh toc2

* Now Open wsjtx-main-toc.html, command line, or browse to the folder.
chromium-browser wsjtx-main-toc2.html
firefox wsjtx-main-toc2.html

If you have any problems, send me a note, I'm sure we can sort it out.

73's
Greg, KI7MT
[email protected]

Attachment: signature.asc
Description: This is a digitally signed message part

_______________________________________________
Wsjt-devel mailing list
[email protected]
https://lists.berlios.de/mailman/listinfo/wsjt-devel

Reply via email to