Skip to content

Commit

Permalink
docs: cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
paulmueller committed Feb 10, 2023
1 parent d61eedc commit d7cc050
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
0.5.2
- docs: cleanup readme
0.5.1
- ci: fix automated pipeline
0.5.0
Expand Down
19 changes: 10 additions & 9 deletions Readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ You can install igor2 via pip::

pip install igor2

The commands `igorbinarywave` and `igorpackedexperiment` are currently
The commands ``igorbinarywave`` and ``igorpackedexperiment`` are currently
not properly implemented (see https://github.com/AFM-analysis/igor2/issues/6),
but it should be straight-forward to fix this.

Expand All @@ -38,23 +38,24 @@ with::
import igor2 as igor


Usage
-----

See the docstrings and unit tests for examples using the Python API.
The package also installs to scripts, ``igorbinarywave.py`` and
``igorpackedexperiment.py`` which can be used to dump files to stdout.

CLI
---
The package also installs to scripts, ``igorbinarywave`` and
``igorpackedexperiment`` which can be used to dump files to stdout.
For details on their usage, use the ``--help`` option. For example::

$ igorbinarywave.py --help
igorbinarywave --help


Testing
-------

Run internal unit tests with::
Run internal unit tests with pytest::

$ nosetests --with-doctest --doctest-tests igor test
pip install -r tests/requirements.txt
pytest tests

The data in the ``test/data`` directory is in the Git repository, but
it is not bundled with the source code. If you want the test data,
Expand Down

0 comments on commit d7cc050

Please sign in to comment.