add readme with explanation and roadmap

This commit is contained in:
nicolalandro 2021-11-13 14:26:55 +01:00
commit 389cc6b450

19
README.md Normal file
View File

@ -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