Skip to content

Commit 5e02b5f

Browse files
committed
updated readme
1 parent 2e9ae4a commit 5e02b5f

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11
# SETS - STO Equipment and Trait Selector
2-
A Star Trek Online build tool in Python
2+
A Star Trek Online build tool in Python. Please refer to the [website](https://stobuilds.com/apps/sets) for information on how this app is used and included features.
33

44
## Installation
5-
Navigate to the folder you downloaded the repository to. (Create a python virtual environment; optional)
6-
Use `pip install .` to install dependencies.
5+
*Note: The commands below are for Windows. If you want to install the app on Linux, use `python3` instead of `python`.*
6+
7+
First, create a folder to house your app. Open a command prompt and navigate *inside* the created folder.
8+
9+
Download the source code. This can be done using `git` or manual download:
10+
- Manual Download: On the GitHub page of [this repository](https://github.com/Shinga13/SETS), click on the green `CODE` button and select "Download ZIP". Save the archive and unpack it so that the files and folders seen on the repository page are *directly* inside your app folder.
11+
- Git: run `git clone https://github.com/Shinga13/SETS.git .`
12+
13+
Install dependencies by running `python -m pip install .`.
14+
15+
To speed up the image download process on first start of the app, download the latest image archive from [releases](https://github.com/Shinga13/SETS/releases). Create a `.config` folder and unpack the images archive into it. The images should be in `<app_root>\.config\images\`.
16+
17+
*Ubuntu* users might need to install the `libxcb-cursor0` package for this app to work: `sudo apt install libxcb-cursor0`
718

819
## Running the app
920
Navigate to your apps folder.
10-
Use `python main.py` to start the app.
21+
- Windows: Use `python main.py` to start the app.
22+
- Linux: Use `python3 main.py` to start the app.

0 commit comments

Comments
 (0)