commit 389cc6b450ace670605db56b5e0b50ddd6ebed93 Author: nicolalandro Date: Sat Nov 13 14:26:55 2021 +0100 add readme with explanation and roadmap diff --git a/README.md b/README.md new file mode 100644 index 0000000..f888875 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Obj2Html +This lib is able to transform an .obj file to HTML that use three.js. +In this way it is possible to have an interactive 3D view that can be used on the browser or into a jupyter notebook. + +## Features +- [] .obj files support +- [] guide for notebook +- [] pipy delivery +- [] .mat files support + +# References +In this chapter I add at least a link for each of the knowledge needed for develop this project. +* python +* git +* how to use setup.py +* python test +* coverage +* gitlab ci/cd +* three.js