README.md 1.86 KB
Newer Older
1 2 3
Barefoot
==========

4 5
Convert ``.fountain`` screenplay files to formatted, plain text screenplays, ready for printing to paper or PDF, all from a Unix shell.

Klaatu's avatar
Klaatu committed
6 7 8 9 10 11 12
Brought to you by `Slackermedia <http://slackermedia.info>`_, with a nice pine-scented open source license (GPL3), so feel free to share or contribute.

For information on Fountain by John August, Nima Yousefi, and Stu Maschwitz, go to `fountain.io <http://fountain.io>`_


Usage
-------
13

Klaatu Sverige's avatar
Klaatu Sverige committed
14
This is, like any good shell utility, a modular piece of a larger pipeline, so you will want to use it along with the ``pr`` command and either ``lpr`` or `text2pdf <http://www.eprg.org/pdfcorner/text2pdf/>`_
15 16 17

The workflow is basically something like this to print:

18
    $ barefoot myScreenplay.fountain | pr -f -t | lpr
19 20 21 22


Or this to print-to-PDF:

23
    $ barefoot myScreenplay.fountain | pr -f -t | text2pdf > myScreenplay.txt 
24 25 26 27 28


Status
-------

29 30 31
[27 June 2016]
I've been using this on fountain files for the past year and it's been doing well. Always interested to hear edge cases or bug reports.

32 33 34 35
[16 June 2015]
This program is in beta. A little more testing and polishing, and then a release. If you are a technical user, you should be able to use this, but you will have to compile it yourself, and it's still rough around the edges. 

[14 June 2015]
36 37 38 39 40 41
This program is pre-alpha, meaning you should not attempt to use it unless you are a developer.


System Requirements
--------------------

42 43
To build and use this application, you must have:

Klaatu Sverige's avatar
Klaatu Sverige committed
44 45 46
   * GCC (specifically, g++)
   * C++ (probably already on your system)
   * Boost (headers and regex libs)
47

48 49

Note:
50
-------
51 52 53

Linux or Unix (BSD, Illumos) are supported. 

54
It should work fine on everything else, but I am unable to test, as I do not run closed source operating systems personally and haven't got access to any closed source systems (certainly not to ones with all the dev tools needed to compile).