Skip to content

Commit

Permalink
Update README and Makefile
Browse files Browse the repository at this point in the history
  • Loading branch information
lbolla committed Jan 5, 2025
1 parent 12e6a1b commit 5692e57
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 6 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ REQUIREMENTS = requirements.txt requirements_dev.txt
help: ## Print this help
@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}'

venv: ## Create venv for EMpy
mkvirtualenv EMpy

develop: upgrade-dev requirements-install ## Install project for development
pip install -e .

Expand Down
24 changes: 18 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,37 @@ Optionally, install `bvp`:
Development
===========

First, download the source code from https://github.com/lbolla/EMpy. Then, from inside a `virtualenv`, install with:
First, download the source code from https://github.com/lbolla/EMpy.

Create a virtualenv with, e.g:

.. code-block:: bash
$> make venv
Then, from inside a `virtualenv`, install dev environment with:

.. code-block:: bash
$> pip install -r requirements_dev.txt
$> python setup.py develop
$> make develop
Run tests with:

.. code-block:: bash
$> python setup.py test
Upgrade dependencies with:

.. code-block:: bash
$> make requirements-upgrade
$> make requirements-sync
Release process
===============

1. Edit CHANGES
2. `bumpversion major|minor|patch`
3. `git push && git push --tags`
2. `make release PART=major|minor|patch`

Citation
========
Expand Down

0 comments on commit 5692e57

Please sign in to comment.