This repository has been archived by the owner on Dec 22, 2023. It is now read-only.
forked from trelby/trelby
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
206fd91
commit c2a648e
Showing
2 changed files
with
43 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |