Skip to content

Commit

Permalink
Extract developer instructions to a separate file
Browse files Browse the repository at this point in the history
README.md is intended for end users so I think it’s good to move
information they don’t need elsewhere.
  • Loading branch information
jrosdahl committed Mar 8, 2021
1 parent 5901796 commit 51c1708
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
28 changes: 28 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
Development
===========

To install in development mode with all required development and testing
dependencies:

# pip3 install -e .[dev]

To run the tests:

# ./test


Packaging
---------

To build the wheel, first install in development mode with `[dev]` extras. This
will ensure that pep517 and twine are installed.

Build the wheel with pep517's build command:

# python3 -m pep517.build .

Upload new the version to PyPI:

# python3 -m twine upload dist/*


28 changes: 0 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,34 +105,6 @@ should look something like this:
crw-rw-rw- 1 root root 1, 9 Jun 10 16:19 urandom


Development
-----------

To install in development mode with all required development and testing
dependencies:

# pip3 install -e .[dev]

To run the tests:

# ./test


Packaging
---------

To build the wheel, first install in development mode with `[dev]` extras. This
will ensure that pep517 and twine are installed.

Build the wheel with pep517's build command:

# python3 -m pep517.build .

Upload new the version to PyPI:

# python3 -m twine upload dist/*


License
-------

Expand Down

0 comments on commit 51c1708

Please sign in to comment.