diff --git a/README.md b/README.md index 30e119c..b89d853 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,30 @@ +# dirtvz ⛰🔭 + +_Web-based, high performance 3D renderer for the mining industry._ + +- [App ⛰🔭](https://kurtlawrence.github.io/dirtvz/) + +Dirtvz is an experimental web-based 3D renderer targeted specifically at the dataset common within +the mining industry. +Dirtvz excels at rendering large, detailed surfaces using novel concepts of tiling and level of +detail built first class into the API. +Dirtvz consists of a library and an app, where the app is targeted as a 'batteries included' web +app that can be included in user apps with low friction. +The library is for inclusion in larger app stacks. +Dirtvz aims to be both a utility and a practical research project. As web-based 3D rendering +continues to improve, dirtvz aims to explore the practical challenges and present solutions which +can be extended to other projects. + +> Please note that dirtvz is is in very early stages of prototyping and there are no stability +> guarantees. The included app is still very rudimentary and support for various objects is +> limited. +> See [Features Roadmap](#Features-Roadmap) for checklist to MVP. # Features Roadmap +This is a quick list of items needing development. +As the project matures, Github issues will be adopted more formally. + - [x] camera interactions - [x] information about cursor location in world coords - [ ] alter lighting properties (UI picker) @@ -9,7 +33,7 @@ - [ ] mesh aerial - [ ] mesh edge rendering - [ ] grid render -- [ ] make gh repo +- [x] make gh repo - [ ] world axis (persistent and on rotate) -- needs UI toggle - [ ] background (UI chooser) - [ ] make axes not pickable @@ -22,7 +46,6 @@ - [ ] ? Load raw triangles at finest lod detail - [ ] world axis behaves poorly at zoom levels - # Developing commands ```sh