diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e4e5f6c --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*~ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e37b855 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Usage +To create a full development environment, go into your project +directory and run: ```./chopin.sh [PROJECT_NAME]```. The rest will be +taken of by the tool. +# Features +## Optimizing WebXDC packing script +The packing script generated by `chopin.sh` optimizes every part of +the WebXDC package: +* Minifies JS, HTML, and CSS files +* Optimizes all image files without loss of quality +* Optimizes audio files without loss of quality +## Pre-commit formatting and linting +* Formats and lints JS, HTML, and CSS so that a consistent code style + and standard is sent to a git repository.