Merge pull request #19 from DunklesArchipel/doc2

Add installation instruction

ChangeLog

@@ -7,30 +7,9 @@ echemdb-converters Change Log
 v0.1.1
 ====================
 
-**Added:**
-
-* Added <news item>.
-
-**Changed:**
-
-* Changed <news item>.
-
-**Deprecated:**
-
-* Deprecated <news item>.
-
-**Removed:**
-
-* Removed <news item>.
-
 **Fixed:**
 
-* Fixed <news item>.
-
-**Performance:**
-
-* Improved <news item>.
-
+* Fixed inferring units from metadata of the CLI `csv`` command.
 
 
 v0.1.0

README.md

@@ -1,2 +1,10 @@
 # echemdb-converters
 Convert raw data into echemdb data packages
+
+## Installation
+
+This package is available on [PiPY](https://pypi.org/project/echemdbconverters/) and can be installed with pip:
+
+```sh .noeval
+pip install echemdbconverters
+```

doc/index.md

@@ -66,32 +66,18 @@ entry = db['eclab_cv_ec']
 entry.rescale({'t':'h', 'E':'mV'}).plot('t', 'E')
 ```
 
-
-
-<!--
-You can cite this project as described [on our zenodo page](https://zenodo.org/badge/latestdoi/637997870).
-
 ## Installation
 
-This package is available on [PiPY](https://pypi.org/project/unitpackage/) and can be installed with pip:
-
-```sh .noeval
-pip install unitpackage
-```
-
-The package is also available on [conda-forge](https://github.com/conda-forge/unitpackage-feedstock) an can be installed with conda
+This package is available on [PiPY](https://pypi.org/project/echemdbconverters/) and can be installed with pip:
 
 ```sh .noeval
-conda install -c conda-forge unitpackage
-```
-
-or mamba
-
-```sh .noeval
-mamba install -c conda-forge unitpackage
+pip install echemdbconverters
 ```
 
 See the [installation instructions](installation.md) for further details.
+
+<!--
+You can cite this project as described [on our zenodo page](https://zenodo.org/badge/latestdoi/XXXXXX).
 -->
 
 ## License

doc/installation.md

@@ -1,104 +1,58 @@
 Installation
 ============
 
-Add description!
-
-<!--
-The recommended way to install the unitpackage is to use your package manager,
-(e.g., `apt-get` on Debian or Ubuntu, `pacman` on Arch Linux, `brew` on macOS.)
-
-You can consult [repology](https://repology.org/project/python:unitpackage/packages)
-to see if the unitpackage is available for your package manager.
-
-Alternatively, the unitpackage can be installed by one of the following
-approaches.
-
 Install with pip from PyPI
 --------------------------
 
-The latest stable version of the unitpackage is available on
-[PyPI](https://pypi.org/project/unitpackage/) for all platforms and can be
+The latest stable version of the echemdbconverters is available on
+[PyPI](https://pypi.org/project/echemdbconverters/) for all platforms and can be
 installed if you have Python and pip installed already:
 
 ```sh
-pip install unitpackage
+pip install echemdbconverters
 ```
 
-This command downloads and installs the unitpackage and its dependencies into
+This command downloads and installs the echemdbconverters and its dependencies into
 your local Python installation.
 
 If the above command fails because you do not have permission to modify your
-Python installation, you can install the unitpackage into your user account:
-
-```sh
-pip install --user unitpackage
-```
-
-You can instead also install the latest unreleased version of the unitpackage
-from our [GitHub Repository](https://github.com/echemdb/unitpackage) with
-
-```sh
-pip install git+https://github.com/echemdb/unitpackage@main
-```
-
-Install with conda from conda-forge
------------------------------------
-
-The unitpackage is [available on
-conda-forge](https://github.com/conda-forge/unitpackage-feedstock) for all
-platforms.
-
-If you don't have conda yet, we recommend to install
-[Miniforge](https://github.com/conda-forge/miniforge#miniforge3).
-
-Miniforge is already pre-configured for conda-forge. If you already had another
-release of conda installed, make sure the conda-forge channel is
-[configured correctly](https://conda-forge.org/docs/user/introduction.html#how-can-i-install-packages-from-conda-forge)
-
-Once your conda setup is ready, create a new `unitpackage` environment with
-the latest stable version of the unitpackage:
-
-```sh
-conda create -n unitpackage
-```
-
-To use the unitpackage, activate the `unitpackage` environment:
+Python installation, you can install the echemdbconverters into your user account:
 
 ```sh
-conda activate unitpackage
+pip install --user echemdbconverters
 ```
 
-To install the unitpackage into an existing environment, activate that environment and then
+You can instead also install the latest unreleased version of the echemdbconverters
+from our [GitHub Repository](https://github.com/echemdb/echemdbconverters) with
 
 ```sh
-conda install unitpackage
+pip install git+https://github.com/echemdb/echemdbconverters@main
 ```
 
 Install with pip for development
 --------------------------------
 
-If you want to work on the unitpackage itself, get a copy of the latest
-unreleased version of the unitpackage:
+If you want to work on the echemdbconverters itself, get a copy of the latest
+unreleased version of the echemdbconverters:
 
 ```sh
-git clone https://github.com/echemdb/unitpackage.git
+git clone https://github.com/echemdb/echemdbconverters.git
 ```
 
 Move to the directory and install the dependencies
 
 ```sh
-conda activate unitpackage
+conda activate echemdbconverters
 conda env create --file environment.yaml
 ```
 
-Create an [editable](https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs) install of the unitpackage:
+Create an [editable](https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs) install of the echemdbconverters:
 
 ```sh
-pip install -e unitpackage
+pip install -e echemdbconverters
 ```
 
-Any changes you make to the files in your local copy of the unitpackage should
+Any changes you make to the files in your local copy of the echemdbconverters should
 now be available in your next Python session.
 
-We would love to see your contribution to the unitpackage.
--->
+We would love to see your contribution to the echemdbconverters.

doc/news/doc2.rst

@@ -0,0 +1,3 @@
+**Added:**
+
+* Added installation instructions to the documentation and readme.