PR: Update docs

AUTHORS.md

@@ -6,4 +6,4 @@
 
 ## Contributors
 
-None yet. Why not be the first?
+* [spyder-env-manager contributors](https://github.com/spyder-ide/spyder-env-manager/graphs/contributors)

CHANGELOG.md

@@ -0,0 +1 @@
+# History of changes

CONTRIBUTING.md

@@ -124,12 +124,12 @@ pytest spyder_env_manager/tests/test_plugin.py
 ## Deploying
 
 A reminder for the maintainers on how to deploy.
-Make sure all your changes are committed (including an entry in HISTORY.rst).
+Make sure all your changes are committed (including an entry in `CHANGELOG.md`).
 Then edit `spyder_env_manager/__init__.py` and update the plugin version and run:
 
 ```bash
 git push
 git push --tags
 ```
 
-Github will then deploy to PyPI if tests pass.
+For more info see `RELEASE.md`

README.md

@@ -1,6 +1,6 @@
 # Spyder Env Manager
 
-Spyder 5+ plugin to manage Python virtual environments and packages
+Spyder 6+ plugin to manage Python virtual environments and packages
 
 ## Build status
 
@@ -15,7 +15,10 @@ Spyder 5+ plugin to manage Python virtual environments and packages
 
 ## Features
 
-* TODO
+* Create and delete Python environments
+* Install, Update, change installed packages inside Python environments
+* Import/Export environments (from/to `.yml` files)
+* Set the environment Python interpreter as the one used by Spyder.
 
 ## Credits
 

RELEASE.md

@@ -0,0 +1,73 @@
+## Instructions to release a new Spyder-env-manager version
+
+To release a new version of spyder-env-manager (on PyPI and Conda-forge) follow these steps
+
+### Prerequisites
+
+In order to do a release, you need to have:
+
+* An environment with the packages required to do the release (`loghub`, `pip`, `setuptools`, `twine`, `wheel`). If using `conda`, you can create a `release` environment with
+
+      conda create -n release python=3.9
+      conda activate release
+      pip install -U pip setuptools twine wheel loghub
+
+* A clone of this repository (usually your fork with an `upstream` remote pointing to the project original repo)
+
+* The corresponding credentials (PyPI, GitHub, etc).
+
+### PyPI
+
+* Update local repo with
+
+      git fetch upstream && git checkout main && git merge upstream/main
+
+* Close the current [milestone on GitHub](https://github.com/spyder-ide/spyder-env-manager/milestones)
+
+* Clean your local repo with (selecting option 1)
+
+      git clean -xfdi
+
+* Update `CHANGELOG.md` with
+
+      loghub spyder-ide/spyder-env-manager -m vX.Y.Z
+
+* Update `__version__` in `spyder_env_manager/__init__.py` (set release version, remove `dev0`):
+
+      git add . && git commit -m "Release X.Y.Z"
+
+* Update the most important release packages with
+
+      pip install -U pip setuptools twine wheel loghub
+
+* Create source distribution and wheel with
+
+      python -bb -X dev -W error -m build
+
+* Check generated files with
+
+      twine check --strict dist/*
+
+* Upload generated files with
+
+      twine upload dist/*
+
+* Create release tag with
+
+      git tag -a vX.Y.Z -m "Release X.Y.Z"
+
+* Update `__version__` in `spyder_env_manager/__init__.py` (add `dev0` and increment minor)
+
+* Create `Back to work` commit with
+
+      git add . && git commit -m "Back to work"
+
+* Push changes and tag with
+
+      git push upstream main && git push upstream --tags
+
+* Create a [GitHub Release](https://github.com/spyder-ide/spyder-env-manager/releases) (`Draft a new release` and `Publish release`). You can use the `Auto generate release notes` as a base template for the release description and to that add a link to the Changelog (the new release related info).
+
+### Conda-forge
+
+* After doing the release on PyPI check for the `regro-cf-autotick-bot` automatic PR on the [Spyder-env-manager feedstock repo](https://github.com/conda-forge/spyder-env-manager-feedstock/pulls). Review it, check if any dependency or changes are needed and merge it.

docs/conf.py

@@ -30,7 +30,7 @@
 HERE = os.path.abspath(os.path.dirname(__file__))
 REPO = os.path.dirname(HERE)
 
-for fpath in ["README.md", "CONTRIBUTING.md", "AUTHORS.md"]:
+for fpath in ["README.md", "CONTRIBUTING.md", "AUTHORS.md", "CHANGELOG.md"]:
     try:
         os.remove(fpath)
     except Exception:

docs/index.rst

@@ -10,6 +10,7 @@ Welcome to Spyder Env Manager's documentation!
    usage
    contributing
    authors
+   changelog
    modules
 
 Indices and tables

docs/installation.md

@@ -5,13 +5,18 @@
 To install Spyder Env Manager, run this command in your terminal:
 
 ```bash
-pip install spyder-env-manager
+conda install -c conda-forge spyder-env-manager
 ```
 
 This is the preferred method to install Spyder Env Manager, as it will always install the most recent stable release.
 
-If you don't have [pip](https://pip.pypa.io) installed, this [Python installation guide(http://docs.python-guide.org/en/latest/starting/installation/) can guide
-you through the process.
+Or with `pip`
+
+```bash
+pip install spyder-env-manager
+```
+
+Note that for the moment you need to have `conda` installed for the plugin to work, so even when installing with `pip`, `conda`also needs to be available
 
 ## From sources
 
@@ -23,14 +28,14 @@ You can either clone the public repository:
 git clone git://github.com/spyder-ide/spyder-env-manager
 ```
 
-Or download the [tarball](https://github.com/spyder-ide/spyder-env-manager/tarball/master):
+Or download the [tarball](https://github.com/spyder-ide/spyder-env-manager/tarball/main):
 
 ```bash
-curl -OJL https://github.com/spyder-ide/spyder-env-manager/tarball/master
+curl -OJL https://github.com/spyder-ide/spyder-env-manager/tarball/main
 ```
 
 Once you have a copy of the source, you can install it with:
 
 ```bash
-python setup.py install
+pip install -e .
 ```

docs/usage.md

@@ -1,7 +1,3 @@
 # Usage
 
-To use Spyder Env Manager in a project:
-
-```python
-import spyder_env_manager
-```
+To use Spyder Env Manager you will need to have `conda` installed and Spyder 6.