From 2446fc544ccf39b18c4260c60f60cc0451fa9386 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=BChnel?= Date: Wed, 18 Apr 2018 09:10:38 +0200 Subject: [PATCH] Make it easier to contribute --- .gitignore | 3 +++ CONTRIBUTING.md | 17 +++++++++++++++++ package.json | 3 +++ 3 files changed, 23 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index ced49a1..d55df02 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +.idea/ +npm-debug.log* + # Windows image file caches Thumbs.db ehthumbs.db diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0731443 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Development + +## Dependencies + +Run the following to install all dependencies: + +```bash +$ npm install +``` + +## Build + +Two steps are necessary to build the project entirely: + +```bash +$ npm run build +``` \ No newline at end of file diff --git a/package.json b/package.json index 655c666..b5db1ae 100644 --- a/package.json +++ b/package.json @@ -30,5 +30,8 @@ "less-plugin-autoprefix": "^1.5.1", "requirejs": "^2.1.22", "run-sequence": "^1.1.2" + }, + "scripts": { + "build": "gulp less && gulp build" } }