Updated docs
h3rald h3rald@h3rald.com
Thu, 07 Aug 2014 22:04:49 +0200
2 files changed,
12 insertions(+),
21 deletions(-)
M
doc/HastyScribe_UserGuide.htm
→
doc/HastyScribe_UserGuide.htm
@@ -228,24 +228,20 @@ <h2 id="Getting.Started">Getting Started<a href="#document-top" title="Go to top"></a></h2>
<h3 id="Downloading.Pre-built.Binaries">Downloading Pre-built Binaries<a href="#document-top" title="Go to top"></a></h3> -<p>The easiest way to get HastyScribe is by downloading one of the prebuilt binaries from the <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.1">Github Release Page</a>:</p> +<p>The easiest way to get HastyScribe is by downloading one of the prebuilt binaries from the <a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.2">Github Release Page</a>:</p> <ul> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.1/hastyscribe_v1.0.1_macosx_x86.zip">HastyScribe for Mac OSX</a> – Compiled on OSX Mavericks</li> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.1/hastyscribe_v1.0.1_windows_x86.zip">HastyScribe for Windows</a> – Compiled on Windows 8.1</li> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.1/hastyscribe_v1.0.1_linux_x86.zip">HastyScribe for Linux (Ubuntu)</a> – Compiled on Ubuntu 12.10</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.2/hastyscribe_v1.0.2_macosx_x86.zip">HastyScribe for Mac OSX</a> – Compiled on OS X Mavericks (LLVM CLANG 6.0)</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.2/hastyscribe_v1.0.2_windows_x86.zip">HastyScribe for Windows</a> – Cross-compiled on OS X Mavericks (MinGW GCC 4.8.0)</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0.2/hastyscribe_v1.0.2_linux_x86.zip">HastyScribe for Linux (Ubuntu)</a> – Cross-compiled on OS X Mavericks (GNU GCC 4.8.1)</li> </ul> <h3 id="Installing.using.Babel">Installing using Babel<a href="#document-top" title="Go to top"></a></h3> -<p>If you already have <a href="http://nimrod-code.org/">Nimrod</a> installed on your computer and you’re running on Windows, Mac OS X or Ubuntu, you can simply run</p> +<p>If you already have <a href="http://nimrod-code.org/">Nimrod</a> installed on your computer, you can simply run</p> <p><span class="cmd">babel install hastyscribe</span></p> - -<div class="warning"><p>Warning</p> - -<p>If you are not using Windows, Mac OS X or Ubuntu, babel installation won’t work. This is due to the fact that HastyScribe requires <span class="file">libmarkdown.a</span> to be placed in the <span class="dir">vendor</span> directory of the HastyScribe source directory – at present, only prebuilt static libraries for Windows, Mac OS X and Ubuntu are distributed with HastyScribe.</p></div> <h3 id="Building.from.Source">Building from Source<a href="#document-top" title="Go to top"></a></h3>@@ -274,7 +270,7 @@
<ol> <li>Download and install <a href="http://nimrod-code.org/">Nimrod</a>.</li> <li>Clone the HastyScribe <a href="https://github.com/h3rald/hastyscribe">repository</a>.</li> -<li>Put your <span class="file">libbmarkdown.a</span> file in the <span class="dir">vendor</span> directory.</li> +<li>Put your <span class="file">libmarkdown.a</span> file in the <span class="dir">vendor</span> directory.</li> <li>Run <span class="cmd">nimrod c hastyscribe.nim</span></li> </ol>
M
doc/HastyScribe_UserGuide.md
→
doc/HastyScribe_UserGuide.md
@@ -73,20 +73,15 @@ ### Downloading Pre-built Binaries
The easiest way to get {{hs}} is by downloading one of the prebuilt binaries from the [Github Release Page][release]: - * [HastyScribe for Mac OSX]({{release}}/hastyscribe_v1.0.1_macosx_x86.zip) -- Compiled on OSX Mavericks - * [HastyScribe for Windows]({{release}}/hastyscribe_v1.0.1_windows_x86.zip) -- Compiled on Windows 8.1 - * [HastyScribe for Linux (Ubuntu)]({{release}}/hastyscribe_v1.0.1_linux_x86.zip) -- Compiled on Ubuntu 12.10 + * [HastyScribe for Mac OSX]({{release}}/hastyscribe_v1.0.2_macosx_x86.zip) -- Compiled on OS X Mavericks (LLVM CLANG 6.0) + * [HastyScribe for Windows]({{release}}/hastyscribe_v1.0.2_windows_x86.zip) -- Cross-compiled on OS X Mavericks (MinGW GCC 4.8.0) + * [HastyScribe for Linux (Ubuntu)]({{release}}/hastyscribe_v1.0.2_linux_x86.zip) -- Cross-compiled on OS X Mavericks (GNU GCC 4.8.1) ### Installing using Babel -If you already have [Nimrod][nimrod] installed on your computer and you're running on Windows, Mac OS X or Ubuntu, you can simply run +If you already have [Nimrod][nimrod] installed on your computer, you can simply run [babel install hastyscribe](class:cmd) - -> %warning% -> Warning -> -> If you are not using Windows, Mac OS X or Ubuntu, babel installation won't work. This is due to the fact that {{hs}} requires [libmarkdown.a](class:file) to be placed in the [vendor](class:dir) directory of the {{hs}} source directory -- at present, only prebuilt static libraries for Windows, Mac OS X and Ubuntu are distributed with {{hs}}. ### Building from Source@@ -113,7 +108,7 @@ Once you have a [libmarkdown.a](class:file) static library for your platform:
1. Download and install [Nimrod][nimrod]. 2. Clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe). -3. Put your [libbmarkdown.a](class:file) file in the [vendor](class:dir) directory. +3. Put your [libmarkdown.a](class:file) file in the [vendor](class:dir) directory. 4. Run [nimrod c hastyscribe.nim](class:cmd) ## Usage@@ -702,4 +697,4 @@ [fa]:http://fortawesome.github.io/Font-Awesome/
[fa-icons]:http://fortawesome.github.io/Font-Awesome/icons/ [pme]:http://michelf.com/projects/php-markdown/extra/ [sudtipos]:http://www.sudtipos.com/ -[release]:{{release -> https://github.com/h3rald/hastyscribe/releases/download/v1.0.1}} +[release]:{{release -> https://github.com/h3rald/hastyscribe/releases/download/v1.0.2}}