Commit 3477f260 authored by Niket Agrawal's avatar Niket Agrawal
Browse files

Merge branch 'update-readme-install-steps' into 'master'

Update readme install steps

Closes #28

See merge request !10
parents 408d360e b127e99f
Pipeline #52728 passed with stages
in 26 minutes and 25 seconds
......@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.1.1] - 2021-02-23
### Fixed
+ Updated the installation section in the README to capture the single command installation via pip. Users who wish to install and use miniff can use `pip install miniff` instead of setting up a development environment explicitly.
## [0.1.0] - 2021-02-15
### Added
......
......@@ -78,52 +78,13 @@ Examples
More information on WSL and its installation instructions are [here](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
### Installation steps
### Installation
1. Clone the repository on your system
```
git clone https://gitlab.kwant-project.org/qt/miniff.git
```
Move to the root of the project by executing `cd miniff/` and continue with the following steps from inside this directory.
Install via pip
2. Install the dependencies
* New Conda environment: use the provided [`environment.yml`](environment.yml).
```
conda env create -n <my-env> -f environment.yml
```
Activate the above created virtual environment
```
conda activate <my-env>
```
* `pip`: use [`requirements.txt`](requirements.txt).
```
pip install -r requirements.txt
```
3. Build and install `miniff`
Use the provided [`setup.py`](setup.py).
```bash
python3 setup.py build
python3 setup.py install
```
4. Verify your installation
```python
python
>>> import miniff
>>>
```
5. (optional) Run tests
```bash
python3 setup.py nosetests
```
```
pip install miniff
```
Contributing
------------
......@@ -138,4 +99,4 @@ See AUTHORS.MD for the list of contributors
License
-------
This work is licensed under BSD 2-Clause License
This work is licensed under the BSD 2-Clause License
......@@ -157,7 +157,7 @@ class ext_modules_lazy(list):
setup(
name='miniff',
version='0.1.0',
version='0.1.1',
author='Artem Pulkin, Viacheslav Ostroukh '
'Niket Agrawal, André Melo, Anastasiia Varentcova',
author_email='gpulkin@gmail.com',
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment