diff options
| author | Joop Kiefte <ikojba@gmail.com> | 2019-01-03 01:52:14 +0100 |
|---|---|---|
| committer | Joop Kiefte <ikojba@gmail.com> | 2019-01-03 01:52:14 +0100 |
| commit | 0a713520274a3550091c22e962b6d27f6564a333 (patch) | |
| tree | df6392a16e05be89c37b8c56f7d9331290d018c7 | |
| parent | cd5fe8352aac81de9c8349e9be61009321ef5dcc (diff) | |
Improve the readme
| -rw-r--r-- | readme.md | 12 |
1 files changed, 11 insertions, 1 deletions
@@ -3,4 +3,14 @@ Lexington commandline tool for screenwriters Lexington helps you convert between Final Draft, Fountain and its own lex file formats, and output to PDF, HTML and ebook formats. -At the moment the tool is usable, but not yet complete. Feel free to contribute! The lex input is more complete than the fountain one at the moment, and enables you to create complete screenplays. +At the moment the Fountain parser should be pretty decent, although still lacking features like simultaneous dialog and forcing character names and action, and inline markup is not yet supported. Also the PDF output doesn't do anything to keep pieces from your screenplay together. Feel free to contribute and help me out in knowing how best to handle this! + +To run the tool, make sure to have Go installed first and then run + +`go get github.com/lapingvino/lexington` + +to install Lexington to your go/bin directory. If this directory is in your execution path, you can then run it like + +`lexington -i inputfile.fountain -o outputfile.pdf -to pdf` + +For a more complete overview of the command line options, use `lexington -help`. |