Skip to content

Commit 37cd9c4

Browse files
committed
Refactoring, updated logo & README
Also added babel file.
1 parent 737503a commit 37cd9c4

23 files changed

+521
-129
lines changed

LICENSE LICENSE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2013 Fabio Cevasco
3+
Copyright (c) 2013-2014 Fabio Cevasco
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of
66
this software and associated documentation files (the "Software"), to deal in

README.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ _HastyScribe_ is a simple command-line program able to convert [markdown](http:/
1414
Because:
1515

1616
* It is a cross-platform, self-contained executable file
17-
* It comes with its own stylesheet, which is automatically embedded into every HTML document
17+
* It comes with its own stylesheet, which is automatically embedded into every HTML document, along with all the needed web fonts
1818
* It is built on top of [Discount](http://www.pell.portland.or.us/~orc/Code/discount/), which means that besides standard markdown you also get:
1919
* strikethrough
2020
* automatic Table of Contents generation
@@ -28,18 +28,19 @@ Because:
2828
* tables
2929
* fenced code blocks
3030
* [Pandoc](http://johnmacfarlane.net/pandoc/)-style docuemnt headers
31+
* It automatically embeds any referenced local image via data URI
32+
* It has supports for text snippets
3133

3234
### What can I use it for?
3335

34-
_HastyScribe_ is best suited to produce standalone, mainly-textual documents such as meeting notes, project status documents, and articles.
36+
_HastyScribe_ is best suited to produce self-contained documents such as essays, meeting notes, project status documents, and articles.
3537

3638
### What language is _HastyScribe_ implemented in?
3739

3840
HastyScribe is implemented in [Nimrod][nimrod], a very expressive language that compiles to C and is able to generate small, standalone and self-contained executable files.
3941

4042
### How do I build _HastyScribe_ from source?
4143

42-
4344
First of all you need a **libmarkdown.a** static library. You can either grab one precompiled (for Windows x64 or OSX x64) from the [vendor](https://github.com/h3rald/hastyscribe/blob/master/vendor) folder of the HastyScribe repository or build your own.
4445

4546
If you choose to build your own:
@@ -57,13 +58,9 @@ If you choose to build your own:
5758

5859
Once you have a **libmarkdown.a** static library for your platform:
5960

60-
1. Download and install [Nimrod][nimrod]. On OSX you can also <tt>brew install nimrod</tt> if you have [HomeBrew](http://brew.sh/) installed.
61+
1. Download and install [Nimrod][nimrod].
6162
2. Download/clone the HastyScribe [repository](https://github.com/h3rald/hastyscribe).
6263
3. Put your **libmarkdown.a** file in the **vendor** directory.
63-
4. Run **osxbuild** (if you are on OSX) or **winbuild.bat** (if you are on windows) or the following:
64-
65-
```
66-
nimrod --clibdir:vendor --clib:markdown c hastyscribe.nim
67-
```
64+
4. Run **nixbuild** (if you are on OSX, Linux or other UNIX-like operating systems) or **winbuild.bat** (if you are on Windows)
6865

6966
[nimrod]: http://nimrod-code.org/

assets/fonts/fontawesome-webfont.woff

100755100644
File mode changed.

assets/fonts/hastyscribe.woff

100755100644
108 Bytes
Binary file not shown.

assets/images/hastyscribe.png

1.37 KB
Loading

0 commit comments

Comments
 (0)