Skip to content

Commit

Permalink
Merge pull request #1 from Cyantoo/install-doc
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Llyfrs authored Oct 17, 2021
2 parents ea5d41c + 677cdbb commit fa5e08c
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,28 @@ GUI application that is using your [Torn City](https://www.torn.com/2531272) API

![image](https://user-images.githubusercontent.com/59464917/137616451-2ab048af-c2de-426a-a9ac-85767e2fff9d.png)

# Installation

This package uses [Pipenv](https://realpython.com/pipenv-guide/#example-usage) to manage dependencies. You first need to install Pipenv :

```pip install --user pipenv```

Then to install all dependencies, in the torn-check-list directory:

```pipenv install --ignore-pipfile```

# Usage

Once the the dependencies are installed, you can run the program with :

```pipenv run python .\torn-task-list.py``` (on Windows).

Alternatively you can use, in the torn-check-list directory:

```pipenv shell```

then run ``torn-task-list.py`` as you would normally do (such as with ``python .\torn-task-list.py`` on Windows).

The file to run is torn-task-list.py

When you run the app there will be a text field where you put your API and then you just press the only button that exists there. This will automatically generate task that you are yet to complete.
Expand Down

0 comments on commit fa5e08c

Please sign in to comment.