From aea5c1d0ea77eb72cdc64e450749e72a6ea8249e Mon Sep 17 00:00:00 2001 From: Hugh Rundle Date: Sat, 5 Sep 2020 17:23:04 +1000 Subject: [PATCH] update docs for v3 Adds more information specific to upgrading from earlier version to v3.x --- docs/index.md | 6 +++++- docs/upgrade.md | 12 ++++++------ 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index 9e43256..0c25e47 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,11 @@ **ephemetoot** is a Python command line tool for deleting old toots. -These docs apply to Version 3. +These docs apply to `ephemetoot` version 3. + +Note that throughout these docs the `pip` command is referred to as `pip3`. This is to help new Python users on systems running both Python 2 and Python 3, which is currently still common and a frequent source of confusion. On some systems, `pip` will be the appropriate command, as it points to Python 3 environments. + +If you are upgrading from an `ephemetoot` version prior to v3.0.0 please see the [upgrading](./upgrade.md) instructions and note that you need to manually uninstall the old version first. * [Installation](./install.md) * [Options](./options.md) diff --git a/docs/upgrade.md b/docs/upgrade.md index a95853b..b2a3049 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -2,15 +2,15 @@ ## Upgrading -### Note for users upgrading from Version 2 to Version 3 +### Note for users upgrading to Version 3 -To upgrade from Version 2.x to Version 3.x you will need to remove your existing install. +To upgrade from an earlier version to Version 3.x you will need to remove your existing install. 1. save a copy of your `config.yaml` file somewhere safe -2. run `pip uninstall ephemetoot` -3. run `pip install ephemetoot` +2. run `pip3 uninstall ephemetoot` +3. run `pip3 install ephemetoot` 4. check your config file is in the current directory -5. do a test run with `ephemetoot --test` +5. check everythign is working with `ephemetoot --test` or `ephemetoot --version` ### Upgrading with pypi To upgrade to a new version, the easiest way is to use pip to download the latest version from pypi (remembering that for your machine you may need to substitute `pip` for `pip3`): @@ -34,7 +34,7 @@ To upgrade without using git or pypi: * put your config file somewhere safe * download and unzip the zip file into your `ephemetoot` directory over the top of your existing installation * move your config file back in to the ephemetoot directory -* run `pip install .` from within the directory +* run `pip3 install .` from within the directory ## Uninstalling