From a29f5df84f081053ae8e8d768aa08eb4c42ce5c2 Mon Sep 17 00:00:00 2001 From: nicolalandro Date: Sun, 14 Nov 2021 16:02:01 +0100 Subject: [PATCH] improve readme with refecerences --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6836428..de2ecc9 100644 --- a/README.md +++ b/README.md @@ -60,11 +60,13 @@ twine upload dist/* # References In this chapter I add at least a link for each of the knowledge needed for develop this project. -* python -* git +* [python](https://www.python.org/): programming language for develop the tool +* [HTML](https://www.w3schools.com/html/): markup language for the output file generated by the tool +* [JavaScript](https://www.w3schools.com/js/): programming language used into the HTML for logic implementation +* [mustache](https://www.elated.com/easy-html-templates-with-mustache/): sintax for dynamic templating ( exist [pymustache](https://github.com/lotabout/pymustache) but I use a custom function with same sintax because of it does not work into js inside html) +* [git](https://git-scm.com/doc): tool used for version control * [how to write a setup.py](https://medium.com/@joel.barmettler/how-to-upload-your-python-package-to-pypi-65edc5fe9c56) -* python test -* coverage -* gitlab ci/cd -* three.js -* [pymustache](https://github.com/lotabout/pymustache): for using html template, but in the end I use replace with similar sintax +* [unittest](https://docs.python.org/3/library/unittest.html): the used python framework for test automation +* [coverage.py](https://coverage.readthedocs.io/en/6.1.2/): lib used for code coverage computation +* [gitlab ci/cd](https://docs.gitlab.com/ee/ci/quick_start/): for run the integration test +* [three.js](https://threejsfundamentals.org/): js lib to open and visualize 3D model