add warning to docs index file

Note about pinning beta version
This commit is contained in:
Hugh Rundle 2020-09-06 14:18:19 +10:00 committed by GitHub
parent d7a7292a2c
commit 0cf95a4bb0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 0 deletions

View File

@ -6,6 +6,12 @@ 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. 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.
**NOTE:** to install ephemetoot from pypi currently you must pin the beta version:
```
pip3 install ephemetoot==3.0.0-beta.0
```
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. 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) * [Installation](./install.md)