Skip to content

Commit

Permalink
final touches
Browse files Browse the repository at this point in the history
  • Loading branch information
afonsojramos committed Apr 28, 2021
1 parent 31ea8da commit b29d02e
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,21 @@ A simple python script that acts as a bridge between [Discord](https://discord.c

*P.S.* Discord needs to be running on the machine Discrakt is running on.

## Install
## Running executables

As usual, it is recommended to use [venv](https://docs.python.org/3/library/venv.html) and [Python 3](https://www.python.org/).
Running the executables is as easy as clicking the provided executables in the latest [release](https://github.com/afonsojramos/discrakt/releases) (`.exe` for Windows and `.sh` for UNIX systems). That's it!

After this, just install the dependencies using `pip install -r requirements.txt`.
## Development

## Running from script
As usual, it is recommended to use [venv](https://docs.python.org/3/library/venv.html) and [Python 3.9](https://www.python.org/).

After the setting things up by following the [install section](#Install), you can run this script with: `python discrakt.py`
After this, simply install the dependencies using `pip install -r requirements.txt`.

When a show is detected a similar output is expected:
### Running from script

After setting things up by following the previous section, you can run this script with: `python discrakt.py`

When a show is detected throught the Trakt API, a similar output is expected in the logs:

![Console](./images/demo/console.png)

Expand Down

0 comments on commit b29d02e

Please sign in to comment.