improve readme with refecerences

This commit is contained in:
nicolalandro 2021-11-14 16:02:01 +01:00
parent e3630f8e4d
commit a29f5df84f

View File

@ -60,11 +60,13 @@ twine upload dist/*
# References # References
In this chapter I add at least a link for each of the knowledge needed for develop this project. In this chapter I add at least a link for each of the knowledge needed for develop this project.
* python * [python](https://www.python.org/): programming language for develop the tool
* git * [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) * [how to write a setup.py](https://medium.com/@joel.barmettler/how-to-upload-your-python-package-to-pypi-65edc5fe9c56)
* python test * [unittest](https://docs.python.org/3/library/unittest.html): the used python framework for test automation
* coverage * [coverage.py](https://coverage.readthedocs.io/en/6.1.2/): lib used for code coverage computation
* gitlab ci/cd * [gitlab ci/cd](https://docs.gitlab.com/ee/ci/quick_start/): for run the integration test
* three.js * [three.js](https://threejsfundamentals.org/): js lib to open and visualize 3D model
* [pymustache](https://github.com/lotabout/pymustache): for using html template, but in the end I use replace with similar sintax