diff --git a/README.md b/README.md index a68706b..90ebb3c 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,26 @@ # archimedes_test -A new Flutter project. +This may evolve into a full-fledged library. + +It's purpose is to provide an open source +[Structure from Motion](https://en.wikipedia.org/wiki/Structure_from_motion) +(SFM) library for Android. + +Currently one doesn't exist. The _technology_ exists (i.e. [Polycam](https://poly.cam/)), +but no open source library for SFM exists. + +The problem here is that most open source SFM librarires rely on pytorch. + +So this project essentially has to create all SFM features from scratch. In fact, I'm +copying the algorithm direcly from the [OpenSFM project](https://github.com/mapillary/OpenSfM). ## Getting Started -This project is a starting point for a Flutter application that follows the -[simple app state management -tutorial](https://flutter.dev/docs/development/data-and-backend/state-mgmt/simple). +I'm starting small. Focusing on testors. Yes, unit tests are included. -For help getting started with Flutter development, view the -[online documentation](https://flutter.dev/docs), which offers tutorials, -samples, guidance on mobile development, and a full API reference. +Run `flutter test` to run tests. Then you know it's working. + +But currently tensors aren't fully implemented. ## Assets