Skip to content

Commit 09c93e7

Browse files
committed
Created README
Trying out the markdown formatter.
1 parent 5aa51a6 commit 09c93e7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.markdown

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
README : mcdemarco/twee
2+
======
3+
4+
This is a working fork of tweecode/twee, the command-line python script to compile twee files into HTML. It includes the 1.2 patch to Sugarcane for the <<back>> macro, but no support yet in Jonah for <<back>>.
5+
6+
This fork has been tested with Python 2.6.1 and 2.7.2 on Mac OS 10.6.8.
7+
8+
***
9+
10+
To run twee, you will need a copy of this project, a local Python installation and a .tw file. Open a command prompt, change to the twee directory, and type something like:
11+
12+
./twee my-input-file.tw > my-output-file.html
13+
14+
To compile to Sugarcane instead of Jonah, use the -t flag:
15+
16+
./twee -t sugarcane my-input-file.tw > my-other-output-file.html
17+
18+
The other targets are not recommended. See the [twee documentation](http://gimcrackd.com/etc/doc/) for more information about using twee.

0 commit comments

Comments
 (0)