diff --git a/README b/README deleted file mode 100644 index 35cdb076..00000000 --- a/README +++ /dev/null @@ -1,6 +0,0 @@ -Trelby is a screenplay writing program. See http://www.trelby.org/ for -more details. - -This is a fork of the original codebase from https://github.com/trelby/trelby, which as of this writing appears to be dormant. - -The major difference of this fork is conversion to Python 3. diff --git a/README.md b/README.md new file mode 100644 index 00000000..63cc48e5 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# Trelby +## Screenplay writing software +Trelby is a screenplay writing program. See http://www.trelby.org/ for +more details. + +### About this project +This is a fork of the original codebase from https://github.com/trelby/trelby, which as of this writing appears to be dormant. + +The major difference of this fork is conversion to Python 3. I also have a list of possible enhancements in mind, and I'd love help updating the Windows packaging so that I can provide a Windows build. + +### Installation + +#### From source + +1. git clone https://github.com/limburgher/trelby.git + +2. cd trelby + +3. pip3 install requirements.txt + +4. ./bin/trelby + +#### Debian and variants + +Download and install the .deb file + +- or - + +1. make deb + +2. Install the resulting .deb file. + +#### Fedora + +Download and install the .rpm file + +- or - + +COMING SOON: sudo dnf install trelby + +#### Windows + +Currently unsupported, see above.