Skip to content

Commit 40c6981

Browse files
committed
Update README.md
1 parent d01f9d3 commit 40c6981

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Make it easier to develop Mendix themes, without the use of [Scout](https://worl
66

77
The following things need to be installed:
88
* [Node.js](https://nodejs.org/en/)
9-
* [SASS & Compass](http://thesassway.com/beginner/getting-started-with-sass-and-compass) **<-- this is probably not necessary when using gulp-sass, will check this**
9+
* [SASS & Compass](http://thesassway.com/beginner/getting-started-with-sass-and-compass) **<-- this is probably not necessary when using gulp-sass, we'll verify this later on**
1010

1111
If you want to use Grunt:
1212
* [Grunt client](http://gruntjs.com/getting-started) (you can install this after installing Node using ```npm install grunt-cli -g```)
@@ -23,11 +23,13 @@ Note:
2323

2424
2.) Unzip in your project root folder
2525

26-
3.) Open a terminal and go to your project root folder
26+
3.) Open a terminal and go to your project root folder.
2727

28-
4.) Install modules using ```npm install```
28+
_If you do this on Windows and you encounter errors with installing the dependencies, open your CMD or Powershell as Administrator._
2929

30-
(To be sure you do not include node dependencies in you team-project, make sure you add the ``node_modules`` folder to your SVN ignore)
30+
4.) Install dependencies using ```npm install```
31+
32+
(**_If you use this for a Teamserver project, make sure you do not include node dependencies in you team-project: add the ``node_modules`` folder to your SVN ignore_**)
3133

3234
## Usage
3335

@@ -36,13 +38,13 @@ Based on your choise between Gulp or Grunt, you have the following options:
3638
* **default**, run from commandline:
3739

3840
```bash
39-
grunt
41+
grunt
4042
```
4143

42-
or
44+
or
4345

4446
```bash
45-
gulp
47+
gulp
4648
```
4749

4850
* **dev**, run from commandline:
@@ -63,13 +65,35 @@ The **default** task will check your theme folder (check Gruntfile.js/Gulpfile.j
6365

6466
The **dev** task will do the same as default, but it will start your browser through a [Browsersync](http://www.browsersync.io/docs/grunt/) proxy. Any changes that you make in the css files will be automatically injected in your browser. You do not have to manually refresh your browser.
6567

68+
## Modifying parameters
69+
70+
There are a few parameters that you can change. Open your ``Gruntfile.js`` or ``Gulpfile.js``, you can change these values at the top:
71+
72+
* ``sourceStyleFolder```
73+
* ``deploymentStyleFolder```
74+
* ``proxyAddress``
75+
76+
Make sure ``proxyAddress`` is pointed to your local deployment.
77+
78+
## Troubleshooting
79+
80+
* **``npm install`` fails**<br /><br />
81+
Make sure you have the package.json and Gruntfile.js/Gulpfile.js in your root folder. Also, if there are errors installing (this can happen when you install the Gulp version), make sure you have administrator rights. See point 3 at Installation.
82+
83+
* **"I started the dev task, but my ``localhost:3000`` keeps loading"**<br /><br />
84+
Have you pointed to the right local deployment address? Check the proxyAddress in your Gulp-/Gruntfile.js. This should correspond to the address of your local deployment.
85+
6686
## Done theming?
6787

6888
Clean your project folder by deleting:
6989
* ```package.json```
7090
* ```Gruntfile.js``` or ```Gulpfile.js```
7191
* ```node_modules``` folder
7292

93+
## TODO
94+
95+
* Check if Sass & Compass are still necessary
96+
7397
## License
7498

7599
Apache License, Version 2.0, January 2004

0 commit comments

Comments
 (0)