"SfR Fresh" - the SfR Freeware/Shareware Archive

Member "asciidoc-8.2.7/INSTALL.txt" of archive asciidoc-8.2.7.tar.gz:

As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field. 
    1 AsciiDoc Installation
    2 =====================
    3 
    4 NOTE: The current version of AsciiDoc requires *Python 2.4 or newer*
    5 to run.  If you don't already have an up-to-date version of Python
    6 installed it can be downloaded from the official Python website
    7 http://www.python.org/.
    8 
    9 The latest AsciiDoc downloads can be found on the AsciiDoc website
   10 http://www.methods.co.nz/asciidoc/downloads.html and at the
   11 SourceForge http://sourceforge.net/projects/asciidoc/.
   12 
   13 Prepackaged AsciiDoc installation
   14 ---------------------------------
   15 The AsciiDoc
   16 http://www.methods.co.nz/asciidoc/downloads.html[downloads page]
   17 lists AsciiDoc packages for various Linux distributions.
   18 
   19 
   20 Distribution tarball installation
   21 ---------------------------------
   22 If your flavor or UNIX or Linux is not supported or you prefer to
   23 install from source use the `install.sh` shell script in the tarball
   24 root directory (thanks to mailto:jlm@ofb.net[Jacob Mandelson] for the
   25 initial implementation of this script).
   26 
   27 `install.sh` installs AsciiDoc executables, configuration files and
   28 man pages in the usual locations. Here's how:
   29 
   30 [subs="normal"]
   31   $ tar -xzf asciidoc-{revision}.tar.gz
   32   $ cd asciidoc-{revision}
   33   $ sudo ./install.sh
   34 
   35 NOTE: This script was tested on Ubuntu Linux.  You may need to edit
   36 `install.sh` if your file locations differ from those wired into the
   37 script.
   38 
   39 The `uninstall.sh` script (actually just a symlink to `install.sh`)
   40 will uninstall AsciiDoc.
   41 
   42 If Vim is installed on your system `install.sh` will install the Vim
   43 syntax highlighter and filetype detection scripts in the global
   44 `/etc/vim` directory (`asciidoc.vim` in `/etc/vim/syntax/` and
   45 `asciidoc_filetype.vim` in `/etc/vim/ftdetect/`).
   46 
   47 To install locally put `asciidoc.vim` in `\~/.vim/syntax/` and
   48 `asciidoc_filetype.vim` in `~/.vim/ftdetect/`.
   49 
   50 
   51 Microsoft Windows installation
   52 ------------------------------
   53 To install the zip formatted distribution just unzip the contents to a
   54 new folder:
   55 
   56 [subs="normal"]
   57   $ mkdir asciidoc
   58   $ cd asciidoc
   59   $ unzip ../asciidoc-{revision}.zip
   60 
   61 
   62 Testing your installation
   63 -------------------------
   64 Test out asciidoc by changing to the AsciiDoc application directory
   65 and convert the User Guide document (`./doc/asciidoc.txt`) to XHTML
   66 (`./doc/asciidoc.html`):
   67 
   68   $ asciidoc doc/asciidoc.txt
   69 
   70 NOTE: Windows users will need to execute the `asciidoc.py` script
   71 directly or create a suitable `asciidoc.bat` file.