summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorivanceras <ivanceras@gmail.com>2017-07-27 18:53:44 +0800
committerGitHub <noreply@github.com>2017-07-27 18:53:44 +0800
commitc49a49c508873a4e924fd09f7282eec929800a70 (patch)
tree87838074c79285730ee7f9bfce6a3d6d96e218a1 /README.md
parent3ad317ea3d576726913a0dc63e4c57747d25bae9 (diff)
Added Links to spec and patreon
Diffstat (limited to 'README.md')
-rw-r--r--README.md92
1 files changed, 48 insertions, 44 deletions
diff --git a/README.md b/README.md
index 6b8582f..bf72503 100644
--- a/README.md
+++ b/README.md
@@ -6,10 +6,58 @@
SvgBobRus is an ascii to svg converter.
+There is a Work-in-Progress spec [here](https://github.com/ivanceras/svgbobrus/blob/master/spec.md)
+Contribution to the spec is welcomed.
+
+I've spent a huge time on developing the spec and implementation on my free-time.
+If you like this project please consider supporting me on [patreon](https://www.patreon.com/ivanceras)
+
[Demo](http://ivanceras.github.io/svgbob-editor/)
[Docs](https://docs.rs/svgbob)
+
+#Using in command line
+
+`cargo install svgbob_cli`
+
+`svgbob` normally operates on stdin and stdout:
+```console
+$ svgbob < examples/long.bob > long.svg
+```
+produces an SVG in `long.svg` similar to the one produced by the old `main` binary. `svgbob` also allows passing arguments instead:
+```console
+$ svgbob examples/long.bob -o long.svg
+```
+And you can mix and match:
+```console
+$ svgbob -o long.svg < examples/long.bob
+$ svgbob examples/long.bob > long.svg
+```
+
+This is also documented in the output of `svgbob --help`:
+```console
+$ svgbob --help
+svgbob 0.1.2
+SvgBobRus is an ascii to svg converter
+
+USAGE:
+ svgbob [OPTIONS] [input]
+
+FLAGS:
+ -h, --help Prints help information
+ -V, --version Prints version information
+
+OPTIONS:
+ -o, --output <output> where to write svg output [default: STDOUT]
+
+ARGS:
+ <input> svgbob text file to parse [default: STDIN]
+```
+
+
+
+
<img src="https://ivanceras.github.io/svgbobrus/svgbob/examples/demo.svg"/>
The SVG image is generated from the ascii text below.
@@ -836,47 +884,3 @@ resist
```
-
-#Using in command line
-
-`cargo install svgbob_cli`
-
-`svgbob` normally operates on stdin and stdout:
-```console
-$ svgbob < examples/long.bob > long.svg
-```
-produces an SVG in `long.svg` similar to the one produced by the old `main` binary. `svgbob` also allows passing arguments instead:
-```console
-$ svgbob examples/long.bob -o long.svg
-```
-And you can mix and match:
-```console
-$ svgbob -o long.svg < examples/long.bob
-$ svgbob examples/long.bob > long.svg
-```
-
-This is also documented in the output of `svgbob --help`:
-```console
-$ svgbob --help
-svgbob 0.1.2
-SvgBobRus is an ascii to svg converter
-
-USAGE:
- svgbob [OPTIONS] [input]
-
-FLAGS:
- -h, --help Prints help information
- -V, --version Prints version information
-
-OPTIONS:
- -o, --output <output> where to write svg output [default: STDOUT]
-
-ARGS:
- <input> svgbob text file to parse [default: STDIN]
-```
-
-
-
-Originally written in elm from the original [project](https://github.com/ivanceras/svgbob)
-
-[Demo site](https://ivanceras.github.io/svgbobrus/)