Skip to content

Commit a2a3e86

Browse files
committed
Update README and Makefile
1 parent 12e6a1b commit a2a3e86

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ REQUIREMENTS = requirements.txt requirements_dev.txt
1010
help: ## Print this help
1111
@grep -E '^[a-zA-Z][a-zA-Z0-9_-]*:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
1212

13+
venv: ## Create venv for EMpy
14+
mkvirtualenv EMpy
15+
1316
develop: upgrade-dev requirements-install ## Install project for development
1417
pip install -e .
1518

README.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,25 +31,37 @@ Optionally, install `bvp`:
3131
Development
3232
===========
3333

34-
First, download the source code from https://github.com/lbolla/EMpy. Then, from inside a `virtualenv`, install with:
34+
First, download the source code from https://github.com/lbolla/EMpy.
35+
36+
Create a virtualenv with, e.g:
37+
38+
.. code-block:: bash
39+
40+
$> make venv
41+
42+
Then, from inside a `virtualenv`, install dev environment with:
3543

3644
.. code-block:: bash
3745
38-
$> pip install -r requirements_dev.txt
39-
$> python setup.py develop
46+
$> make develop
4047
4148
Run tests with:
4249

4350
.. code-block:: bash
4451
45-
$> python setup.py test
52+
Upgrade dependencies with:
53+
54+
.. code-block:: bash
55+
56+
$> make requirements-upgrade
57+
$> make requirements-sync
58+
4659
4760
Release process
4861
===============
4962

5063
1. Edit CHANGES
51-
2. `bumpversion major|minor|patch`
52-
3. `git push && git push --tags`
64+
2. `make release PART=major|minor|patch`
5365

5466
Citation
5567
========

0 commit comments

Comments
 (0)