diff --git a/README.md b/README.md index 4199195..6b56e1f 100755 --- a/README.md +++ b/README.md @@ -1 +1,14 @@ This repository contains the core functionality of Doodle3D Transform. + +## Build & run locally +```bash +git clone git@github.com:Doodle3D/Doodle3D-Core.git +cd Doodle3D-Core +npm install # Make sure you have installed NPM / NodeJS first +npm run start +# visit http://localhost:8080 +``` + +## Doodle3D-Transform +The Doodle3D-Core repo just contains the core drawing features of Doodle3D Transform. To get the other features like file management, exporting and slicing you should visit the Doodle3D Transform repository: https://github.com/Doodle3D/Doodle3D-Transform +