Added support for babel package manager Closes #12
h3rald h3rald@h3rald.com
Sun, 27 Jul 2014 14:44:13 +0200
7 files changed,
45 insertions(+),
18 deletions(-)
M
README.md
→
README.md
@@ -61,6 +61,6 @@
1. Download and install [Nimrod][nimrod]. 2. Clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe). 3. Put your **libmarkdown.a** file in the **vendor** directory. -4. Run **nixbuild** (if you are on OSX, Linux or other UNIX-like operating systems) or **winbuild.bat** (if you are on Windows) +4. Run **nimrod c -l:-lmarkdown -l:-L./vendor** [nimrod]: http://nimrod-code.org/
M
doc/HastyScribe_UserGuide.htm
→
doc/HastyScribe_UserGuide.htm
@@ -91,6 +91,7 @@ </li>
<li><a href="#Getting.Started">Getting Started</a> <ul> <li><a href="#Downloading.Pre-built.Binaries">Downloading Pre-built Binaries</a></li> + <li><a href="#Installing.using.Babel">Installing using Babel</a></li> <li><a href="#Building.from.Source">Building from Source</a></li> </ul> </li>@@ -227,13 +228,23 @@ <h2 id="Getting.Started">Getting Started</h2>
<h3 id="Downloading.Pre-built.Binaries">Downloading Pre-built Binaries</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">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.1">Github Release Page</a>:</p> <ul> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0/hastyscribe_v1.0_osx.zip">HastyScribe for Mac OSX</a> – Compiled on OSX Mavericks</li> -<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.0/hastyscribe_v1.0_win.zip">HastyScribe for Windows</a> – Compiled on Windows 7</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.1/hastyscribe_v1.1_osx.zip">HastyScribe for Mac OSX</a> – Compiled on OSX Mavericks</li> +<li><a href="https://github.com/h3rald/hastyscribe/releases/download/v1.1/hastyscribe_v1.1_win.zip">HastyScribe for Windows</a> – Compiled on Windows 7</li> </ul> + +<h3 id="Installing.using.Babel">Installing using Babel</h3> + +<p>If you already have <a href="http://nimrod-code.org/">Nimrod</a> installed on your computer and you’re running on Windows or Mac OS X, you can simply run</p> + +<p><span class="cmd">babel install hastyscribe</span></p> + +<div class="warning"><p>Warning</p> + +<p>If you are using Windows or Mac OS X, 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 and Mac OS X are distributed with HastyScribe.</p></div> <h3 id="Building.from.Source">Building from Source</h3>@@ -263,7 +274,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>Run <span class="cmd">nixbuild</span> (if you are on OSX, Linux or other UNIX-like operating systems) or <span class="cmd">winbuild.bat</span> (if you are on Windows)</li> +<li>Run <span class="cmd">nimrod c -l:-lmarkdown -l:-L./vendor</span></li> </ol>@@ -1041,7 +1052,7 @@ </ul>
</div> <div id="footer"> - <p>Fabio Cevasco – July 20, 2014</p> + <p>Fabio Cevasco – July 27, 2014</p> <p><span>Powered by</span> <a href="https://h3rald.com/hastyscribe"><span class="hastyscribe"></span></a></p> </div> </body>
M
doc/HastyScribe_UserGuide.md
→
doc/HastyScribe_UserGuide.md
@@ -73,8 +73,19 @@ ### 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_osx.zip) -- Compiled on OSX Mavericks - * [HastyScribe for Windows]({{release}}/hastyscribe_v1.0_win.zip) -- Compiled on Windows 7 + * [HastyScribe for Mac OSX]({{release}}/hastyscribe_v1.1_osx.zip) -- Compiled on OSX Mavericks + * [HastyScribe for Windows]({{release}}/hastyscribe_v1.1_win.zip) -- Compiled on Windows 7 + +### Installing using Babel + +If you already have [Nimrod][nimrod] installed on your computer and you're running on Windows or Mac OS X, you can simply run + +[babel install hastyscribe](class:cmd) + +> %warning% +> Warning +> +> If you are using Windows or Mac OS X, 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 and Mac OS X are distributed with {{hs}}. ### Building from Source@@ -102,7 +113,7 @@
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. -4. Run [nixbuild](clasS:cmd) (if you are on OSX, Linux or other UNIX-like operating systems) or [winbuild.bat](class:cmd) (if you are on Windows) +4. Run [nimrod c -l:-lmarkdown -l:-L./vendor](class:cmd) ## Usage@@ -690,4 +701,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}} +[release]:{{release -> https://github.com/h3rald/hastyscribe/releases/download/v1.1}}
M
hastyscribe.babel
→
hastyscribe.babel
@@ -1,8 +1,8 @@
[Package] name = "hastyscribe" -version = "1.0.0" +version = "1.1.0-dev" author = "Fabio Cevasco" -description = "Self-contained markdown compiler generating self-container HTML files" +description = "Self-contained markdown compiler generating self-contained HTML documents" license = "MIT" bin = "hastyscribe"@@ -34,11 +34,9 @@ doc/HastyScribe_UserGuide.md
hastyscribe.nim LICENSE.md markdown.nim -nixbuild README.md vendor/libmarkdown_osx.a vendor/libmarkdown_win.a -winbuild.bat """ [Deps]
A
hastyscribe.nimrod.cfg
@@ -0,0 +1,11 @@
+define: "release" + +passL: "-L./vendor" + +@if macosx: + passL: "-lmarkdown_osx" +@end + +@if windows: + passL: "-lmarkdown_win" +@end
D
nixbuild
@@ -1,2 +0,0 @@
-#!/usr/bin/env bash -nimrod c -l:-lmarkdown -l:-L$PWD/vendor hastyscribe.nim