docs(readme): update installation guide
@@ -17,25 +17,24 @@ As universal function approximators, artificial neural networks have been shown
# Installation
-## Install via pip
+## Using pip
-Like most standard libraries, `neurodiffeq` is hosted on [PyPI](https://pypi.org/project/neurodiffeq/). To install the latest stable relesase, simply use the `pip` (or `pip3`) tool.
+Like most standard libraries, `neurodiffeq` is hosted on [PyPI](https://pypi.org/project/neurodiffeq/). To install the latest stable relesase,
-```sh
-pip install neurodiffeq
-# or try: pip3 install neurodiffeq
+```bash
+pip install -U neurodiffeq # '-U' means update to latest version
```
-## Manual Install
+## Manually
Alternatively, you can install the library manually to get early access to our new features. This is the recommended way for developers who want to contribute to the library.
-1. (optional) Create a new environment. With `conda`: `conda create --name [name of the new environment] python=3.7` and activate the enviroment by `conda activate [name of the new environment]`; With `venv`: `python3 -m venv temp [path to the new environment]` and activate the environment by `source [path to the new environment]/bin/activate`
-2. Clone the repo by `git clone https://github.com/odegym/neurodiffeq.git` and `cd` into the root directory of the repo by `cd neurodiffeq`
-3. Install the dependencies by `pip install -r requirements.txt` and install `neurodiffeq` by `pip install .`
-4. (optional) Run tests `cd tests && pytest`
-
-1. (optional) Deactivate the environment. With `conda`: `conda deactivate`; With `venv`: `deactivate`
+```bash
+git clone https://github.com/NeuroDiffGym/neurodiffeq.git
+cd neurodiffeq && pip install -r requirements
+pip install . # To make changes to the library, use `pip install -e .`
+pytest tests/ # Run tests. Optional.
+```
# Getting Started
