From abf1327062383d7db4334b160364dc36c3329af6 Mon Sep 17 00:00:00 2001 From: Joshua Heimbach Date: Mon, 19 Mar 2018 10:48:57 +0000 Subject: [PATCH] Add build steps --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d04a8d4 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# MI-Chord + +A visual chord representation of protein complex data from: +https://www.ebi.ac.uk/complexportal/ + + +### Development + +MI-Chord uses `gulp` to compile itself +```bash +npm install -g gulp +``` + +To build the project and watch for changes, use the default gulp task: +```bash +gulp +``` + +To release a compressed (production) version of the project: +```bash +gulp deploy +``` + +Note that while the source code is in coffeescript, the compiled JavaScript files are included in the repository to provide better integration with other NodeJS build solutions, such as a webpack.