diff --git a/README.md b/README.md new file mode 100644 index 0000000..c739933 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# t2-model-skinner + +[Launch the app!](https://exogen.github.io/t2-model-skinner/) + +## Development + +Clone the repository and run: + +```console +$ npm install +``` + +Then run `npm start` to launch the development server: + +```console +$ npm start +``` + +Build the production version of the app with `npm run build`: + +```console +$ npm run build +``` + +You will also need to clone the [t2-skins](https://github.com/exogen/t2-skins) +repository, which is the source for all the custom skins that will be listed in +the dropdown menu. Adding a new skin to that repository will make it +automatically appear in the menu during build time. + +If [t2-skins](https://github.com/exogen/t2-skins) is not a sibling folder to +`t2-model-skinner`, set the `T2_SKINS_PATH` environment variable to its path.