Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
mitaa committed Sep 27, 2024
1 parent 88c6f0c commit 7216590
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,27 @@ A simple production planner for Satisfactory.
Requires Python 3.10 or later.\
Make sure that python has been added to the *PATH* environment variable (tick the checkbox when installing python).

<details>
<summary>Release Version</summary>


Download a `*.whl.zip` file from one of the [releases](https://github.com/mitaa/production_planner/releases) and extract it.

Run the `install.bat` file

Or open the terminal (e.g. PowerShell) and run the following command

```
# (adjust the file name accordingly)
pip install production_planner-0.3-py3-none-any.whl
```
</details>


<details>
<summary>Development Version</summary>


[Download](https://github.com/mitaa/production_planner/archive/refs/heads/master.zip) the repository and extract it.

And run the `install.bat` file
Expand All @@ -22,6 +43,7 @@ Or open the terminal (e.g. PowerShell) and run the following command
```
pip install git+https://github.com/mitaa/production_planner.git#egg=production_planner
```
</details>

## Usage
Run the `run.bat` file
Expand Down
Binary file modified data/production_planner-readme.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7216590

Please sign in to comment.