Skip to content

Commit

Permalink
Added Installation section to readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffrimko committed Mar 7, 2015
1 parent cebdd84 commit 2e69a7d
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ The current status is **alpha development**. For now the software is largely a p

This project is targeting Windows during alpha development. Porting to other platforms is planned for future versions.

## Installation
The plan is to release Doctrine as a stand-alone executable (e.g. `doctrine.exe` on Windows). The only installation required would be to copy the executable to a directory.

The source for Doctrine can be ran if the following required items are installed:

- Python 2.7
- PySide 1.2.2

## Usage
To view a document, simply open it in Doctrine. The markup will be rendered to a temporary file which will be deleted either upon exiting Doctrine or when another document is opened.

Expand Down

0 comments on commit 2e69a7d

Please sign in to comment.