Skip to content

Commit

Permalink
Update README to use pip install from pypi.org
Browse files Browse the repository at this point in the history
  • Loading branch information
crisbal committed Oct 19, 2022
1 parent 6bab200 commit 56065db
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,21 @@ First time only:
* Linux: `apt install python3` (or equivalent)
* Windows: [Official webiste](https://www.python.org/)
* MacOS: You should have it already installed
+ Clone/Download this repository
* [Click here](https://github.com/crisbal/album-splitter/archive/refs/heads/master.zip) to download it as a ZIP and extract it
* Or use `git clone https://github.com/crisbal/album-splitter/`
+ Open your terminal app and navigate to where you have extracted/cloned the `album-splitter` project
* For example: `cd Downloads/album-splitter`
* Use `ls` (or `dir` on Windows) to check that you are in a folder containing a `README.md`
+ Create a virtual environment: `python3 -m venv venv`
+ Open your terminal app
+ Create a virtual environment
* `python3 -m venv venv`
+ Activate the virtual environment
* Linux/MacOS: `source venv/bin/activate`
* Windows: `./venv/Scripts/activate`
+ Install the package
* `python3 -m pip install .`
+ Install album-splitter
* `python3 -m pip install album-splitter`
+ You are ready to go!

After the first time:

+ Open your terminal app and navigate to where you have extracted/cloned the `album-splitter` project
+ Open your terminal app
+ Optional, update album-splitter:
* `python3 -m pip install --upgrade album-splitter`
+ Activate the virtual environment
* Linux/MacOS: `source venv/bin/activate`
* Windows: `./venv/Scripts/activate`
Expand Down Expand Up @@ -133,6 +131,10 @@ To get the full help and all the available options run `python -m album_splitter

If you need any help just [create an Issue](https://github.com/crisbal/album-splitter/issues) or send me an email at the address you can find on my profile.

## Updating

To update to use the latest version of album-splitter you can use `python3 -m pip install --upgrade album-splitter`

## Want to help?

If you want to improve the code and submit a pull request, please feel free to do so.
Expand Down

0 comments on commit 56065db

Please sign in to comment.