|
@@ -110,6 +110,19 @@ Assuming that `npm` and `grunt` are installed globally, run a few commands:
|
|
|
1. `npm install` – Downloads all project dependencies into `node_modules`.
|
|
1. `npm install` – Downloads all project dependencies into `node_modules`.
|
|
|
2. `grunt githooks`– (optional) If you want to have pre-commit linting enabled straight in your project.
|
|
2. `grunt githooks`– (optional) If you want to have pre-commit linting enabled straight in your project.
|
|
|
|
|
|
|
|
|
|
+## Additional Directories
|
|
|
|
|
+
|
|
|
|
|
+Other than the files available in this repository, it is expected that target projects will also contain the following directories:
|
|
|
|
|
+
|
|
|
|
|
+* **/src/**<br>
|
|
|
|
|
+ The source code of the project.
|
|
|
|
|
+
|
|
|
|
|
+* **/build/**<br>
|
|
|
|
|
+ If any build is created, it should be placed in this folder.
|
|
|
|
|
+
|
|
|
|
|
+* **[module|group]/tests/**<br>
|
|
|
|
|
+ The place for tests. Its final placement is per project. It can either stay in the project root or inside sub-directories that represent parts of the project, like modules or plugins.
|
|
|
|
|
+
|
|
|
## Boilerplate License
|
|
## Boilerplate License
|
|
|
|
|
|
|
|
Copyright (c) 2014 CKSource - Frederico Knabben
|
|
Copyright (c) 2014 CKSource - Frederico Knabben
|