Skip to content
This repository has been archived by the owner on Dec 22, 2023. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
limburgher committed Feb 22, 2021
1 parent 206fd91 commit c2a648e
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 6 deletions.
6 changes: 0 additions & 6 deletions README

This file was deleted.

43 changes: 43 additions & 0 deletions README.md
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.

0 comments on commit c2a648e

Please sign in to comment.