first commit

README.md

@@ -0,0 +1,36 @@
+# 📦 bellande_robot_step
+[![PyPI version](https://badge.fury.io/py/bellande_robot_step.svg)](https://badge.fury.io/py/bellande_robot_step)
+
+### 🦾 motivation
+- easy to use package to solve an easy problem
+
+### ✔️ confirmed versions
+- `The step function efficiently computes the next step towards a target node within a specified distance limit.'
+
+## Website
+- https://pypi.org/project/bellande_robot_step/
+
+### Installation
+- clone this repo
+- `$ pip install bellande_robot_step`
+- `$ pip show -f bellande_robot_step`
+
+```
+Name: bellande_robot_step
+Version: 0.1.0
+Summary: Computes the next step towards a target node
+Home-page: github.com/RonaldsonBellande/bellande_robot_step
+Author: Ronaldson Bellande
+Author-email: ronaldsonbellande@gmail.com
+License: GNU General Public License v3.0
+Requires: numpy
+Required-by:
+```
+
+### 📦 publish to PyPI
+- use [pypa/build](https://github.com/pypa/build), a simple PEP 517 frontend and [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish)
+- https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+
+
+### License
+This Package is distributed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), see [LICENSE](https://github.com/RonaldsonBellande/bellande_robot_step/blob/main/LICENSE) and [NOTICE](https://github.com/RonaldsonBellande/bellande_robot_step/blob/main/LICENSE) for more information.