Skip to content

Commit 700ce6c

Browse files
authored
Update README.md
1 parent ae620f9 commit 700ce6c

File tree

1 file changed

+15
-37
lines changed

1 file changed

+15
-37
lines changed

README.md

Lines changed: 15 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Gulp for Mendix theming
22

3-
> **Note: With Mendix 8, we decided to go with a different tool: [Calypso](https://docs.mendix.com/howto/front-end/calypso). That is the officially supported tool. It will still be possible to do styling using ux-theming, but it is not officially supported. If you encounter problems using Gulp, please move to Calypso.**
3+
> **Note: With Mendix 8, we decided to go with a different tool: [Calypso](https://docs.mendix.com/howto/front-end/calypso). That is the officially supported tool. It will still be possible to do styling using ux-theming, but _it is not officially supported_. If you encounter problems using Gulp, please move to Calypso.**
44
55
Make it [easier to develop Mendix themes](https://docs.mendix.com/howto/ux/style-with-gulp-and-sass), without the use of [Scout](https://docs.mendix.com/howto/ux/create-a-custom-theme-with-the-mendix-ui-framework) or [Koala](https://docs.mendix.com/howto/ux/setup-mendix-ui-framework-with-koala)
66

@@ -9,74 +9,52 @@ Make it [easier to develop Mendix themes](https://docs.mendix.com/howto/ux/style
99
## Prerequisites (only need to do this once)
1010

1111
The following things need to be installed:
12-
* [Node.js](https://nodejs.org/en/) **Please ensure you install the LTS version, 10.x.x. This is important!! It will fail on older versions like Node 6.x.x. Version 8 might still work, but is not supported by Node anymore**
12+
* [Node.js](https://nodejs.org/en/) **Please ensure you install the LTS version, 14.x.x. This is important!! It will fail on older versions*
1313

14-
If you want to use Gulp (**recommended**):
15-
* [Gulp client](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md) (you can install this after installing Node using ```npm install gulp-cli -g```). **Note: Per version 1.6.0 this is unnecessary, because you can run it using npm**
14+
For Windows it is *recommended* to install Node.js through `nvm-windows`, in order to avoid issues with acces rights. You can find a [Microsoft install guide here](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows#install-nvm-windows-nodejs-and-npm)
1615

17-
If you want to use Grunt:
18-
* [Grunt client](http://gruntjs.com/getting-started) (you can install this after installing Node using ```npm install grunt-cli -g```)
16+
## Installation (automated)
1917

20-
Note:
21-
> We have provided both Grunt and Gulp, but we recommend you use the **Gulp version**. The reason for this is that Gulp works with pipes, which makes it extremely fast. In a few tests we did, Gulp performed the tasks in 150ms, while Grunt took 4 seconds. Yet, because there are people that use Grunt (and the first version of ux-theming only had a Gruntfile), we include this one as well.
18+
Run `npx install-ux-theming` in your project folder (terminal like CMD or Powershell)
2219

23-
## Installation
20+
## Installation (Manual)
2421

2522
1.) Download the latest release (ZIP-file) [here](https://github.com/JelteMX/ux-grunt-theming/releases). **Do NOT download the source files, but choose Gulp.zip**
2623

2724
2.) Unzip in your project root folder
2825

2926
3.) Open a terminal and go to your project root folder.
3027

31-
_If you do this on Windows and you encounter errors with installing the dependencies, open your CMD or Powershell as Administrator._
28+
_If you do this on Windows and you encounter errors with installing the dependencies, open your CMD or Powershell as Administrator. This shouldn't happen if you installed Node.JS through NVM-Windows, see above_
3229

3330
4.) Install dependencies using ``npm install``
3431

3532
(**_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_**)
3633

3734
## Usage
3835

39-
### 1.6.0 and newer
40-
Per version 1.6.0 you can use the following task using **npm** instead of **gulp**:
41-
4236
* **default**
4337

38+
Will compile your sass everytime you make a change
39+
4440
```bash
4541
npm run start
4642
```
4743

4844
* **dev**
4945

50-
```bash
51-
npm run dev
52-
```
53-
54-
### 1.5.1 and older
55-
56-
Based on your choice between Gulp or Grunt, you have the following options:
57-
58-
* **default**, run from commandline:
46+
Will run browsersync and watch your files
5947

6048
```bash
61-
gulp
62-
```
63-
64-
or
65-
66-
```bash
67-
grunt
49+
npm run dev
6850
```
6951

70-
* **dev**, run from commandline:
71-
72-
```bash
73-
gulp dev
74-
```
52+
* **build**
7553

76-
or
54+
Builds a minified version of the CSS
7755

7856
```bash
79-
grunt dev
57+
npm run build
8058
```
8159

8260
### Tasks:
@@ -204,7 +182,7 @@ None
204182
## License
205183

206184
The MIT License (MIT)
207-
Copyright (c) 2019 Mendix
185+
Copyright (c) 2021 Mendix
208186

209187
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
210188

0 commit comments

Comments
 (0)