From c407abe517e8a608b25481aa4d92c686bb7f6cf4 Mon Sep 17 00:00:00 2001 From: Mario Fink Date: Thu, 2 Sep 2021 13:05:46 +0200 Subject: [PATCH] * README.md: add install notes regarding pip install * pip-release: extract proper part of README.md for pip package * bump version 1.0.3 --- README.md | 10 ++++++---- pip/makefile | 2 +- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6e0b6fa..1ddf4b1 100644 --- a/README.md +++ b/README.md @@ -160,19 +160,21 @@ make cython-requirements make cython-install ``` -That makes the module available for import as a `import tdm_termite` . +which makes the module available for import by `import tdm_termite` . #### Installation with pip -The package is also available via the [Python Package Index](https://pypi.org) at +The package is also available via the [Python Package Index](https://pypi.org) at [TDMtermite](https://pypi.org/project/TDMtermite/). To install the latest version simply do ```Shell python3 -m pip install TDMtermite ``` -Note, that _python3_setuptools_ and _gcc version >= 10.2.0_ are required to -successfully install and use it. +##### Unix + +Note, that _python3_setuptools_ and _gcc version >= 10.2.0_ are required to +successfully install and use it. ## Usage diff --git a/pip/makefile b/pip/makefile index 3f998f6..e649a38 100644 --- a/pip/makefile +++ b/pip/makefile @@ -7,7 +7,7 @@ pip-sdist: ../cython/py_tdm_termite.pyx ../cython/tdm_termite.pxd ../cython/py_t cp -v ../cython/py_tdm_termite.cpp ./ cp -v ../lib/*.hpp ../lib/*.cpp ./ cp -v ../3rdparty/pugixml/* ./ - cat ../README.md | head -n316 | tail -n306 > ./README.md + cat ../README.md | grep '^# TDMtermite' -A 50000 > ./README.md cp -v ../LICENSE ./ # cython py_tdm_termite.pyx -o py_tdm_termite.cpp python3 setup.py sdist