Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jrm5100 committed Dec 12, 2019
1 parent 67c8fd0 commit bcf482d
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,48 @@
# CLARITE-GUI

[![Documentation Status](https://readthedocs.org/projects/clarite-gui/badge/?version=latest)](https://clarite-gui.readthedocs.io/en/latest/?badge=latest)

A GUI Version of CLARITE

![alt text][logo]

[logo]: src/main/resources/base/images/clarite_logo.png "CLARITE Logo"

Full documentation on [ReadTheDocs.io](https://clarite-gui.readthedocs.io/en/stable/)

## Install

Requires Python v3.6

1. Download the repository and navigate to the main folder
2. Create a python venv

python -m venv venv

3. Activate the environment

On Mac/Linux:

source venv/bin/activate

On Windows:

call venv\scripts\activate.bat

4. Install the requirements

On Mac/Linux:

source src\requirements\base.txt

On Windows:

pip install -r src\requirements\windows.txt


## Running

1. Activate the environment
1. Activate the environment (if not already activated)

On Mac/Linux:

Expand Down

0 comments on commit bcf482d

Please sign in to comment.