From 51c1708c25133d536ae8296e15eeca127e0e128e Mon Sep 17 00:00:00 2001 From: Joel Rosdahl Date: Mon, 8 Mar 2021 19:45:29 +0100 Subject: [PATCH] Extract developer instructions to a separate file MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit README.md is intended for end users so I think it’s good to move information they don’t need elsewhere. --- DEVELOPMENT.md | 28 ++++++++++++++++++++++++++++ README.md | 28 ---------------------------- 2 files changed, 28 insertions(+), 28 deletions(-) create mode 100644 DEVELOPMENT.md diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..1bc50ae --- /dev/null +++ b/DEVELOPMENT.md @@ -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/* + + diff --git a/README.md b/README.md index a3603dc..6ccfc26 100644 --- a/README.md +++ b/README.md @@ -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 -------