Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #1

Merged
merged 1 commit into from
Oct 17, 2021
Merged

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions README.md
View file
Open in desktop
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