update docs with upgrade instructions

This commit is contained in:
Hugh Rundle 2020-04-27 15:42:44 +10:00
parent 38699156c4
commit 4f6550f269
1 changed files with 13 additions and 1 deletions

View File

@ -27,7 +27,6 @@ If you already have `git` installed on the machine where you're running ephemeto
```shell
git clone https://github.com/hughrun/ephemetoot.git
cd ephemetoot
git fetch --tags
git checkout [tagname]
```
### get code by downloading zip file
@ -42,6 +41,10 @@ With some Python 3 installations (e.g on MacOS with Homebrew) you may need to us
```shell
pip3 install .
```
If you do not have permission to install python modules, you may need to use the `--user` flag:
```shell
pip3 install . --user
```
## Obtain an access token
@ -176,6 +179,15 @@ Prior to Python 3.7, running a Python script on some BSD and Linux systems may t
* setting a _locale_ that encodes utf-8, by using the environment setting `PYTHONIOENCODING=utf-8` when running the script, or
* upgrading your Python version to 3.7 or higher. See [Issue 11](https://github.com/hughrun/ephemetoot/issues/11) for more information.
# Upgrading
To upgrade to a new version, run the following from inside the `ephemetoot` directory:
```shell
git fetch --tags
git checkout [tagname]
pip3 install .
```
# Uninstalling
Uninstall using pip;