Skip to content

Commit 9afc578

Browse files
Update readme.md file
1 parent 94b0268 commit 9afc578

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,61 @@
1-
Blank Theme
2-
===
1+
# Blank Theme
32

4-
Blank Theme is a custom blank theme created with underscore theme, which includes foundation basic grid system and some basic customizer settings which are required in almost all projects.
3+
Blank Theme is a custom blank theme created with the underscore theme, which includes the Foundation basic grid system and some basic customizer settings required in almost all projects.
54

5+
## Getting Started
66

7-
8-
Getting Started
9-
---------------
10-
11-
After cloning repo run
7+
After cloning the repo, run the following:
128

139
```bash
1410
npm install
1511
```
1612

17-
and then run the following command which will prompt for the theme name, start renaming and do cleanup.
13+
Then run the following command which will prompt for the theme name, start renaming, and clean up:
1814

1915
```bash
2016
npm run init
2117
```
2218

23-
24-
2519
#### Compile Assets
2620

27-
```
28-
npm run dev # During development
29-
npm run prod # When ready for production
30-
```
31-
21+
To compile assets, use the following commands:
3222

23+
```bash
24+
npm run build:dev # During development
25+
npm run build:prod # When ready for production
26+
```
3327

3428
#### Other Commands
3529

3630
```bash
37-
# Generate pot files
38-
npm run pot
31+
# Generate POT files
32+
npm run build:pot
33+
34+
# Lint all at once
35+
npm run lint:all
36+
37+
# Lint only staged files
38+
npm run lint:staged
3939

40-
# Lint CSS, JS and PHP
40+
# Lint individual CSS, JS, PHP and package.json
4141
npm run lint:css
42+
npm run lint:css:fix
4243
npm run lint:js
44+
npm run lint:js:fix
45+
npm run lint:js:report
4346
npm run lint:php
4447
npm run lint:php:fix
48+
npm run lint:package-json
4549
```
4650

51+
#### Before Commit
4752

48-
49-
#### Before commit
50-
51-
This `precommit` script will lint your scss, js, php files and also generate pot file.
53+
This `precommit` script will lint your SCSS, JS, PHP files and also generate the POT file:
5254

5355
```bash
5456
npm run precommit
5557
```
5658

59+
## Does this interest you?
5760

58-
59-
Does this interest you?
60-
---------------
61-
<a href="https://rtcamp.com/"><img src="https://rtcamp.com/wp-content/uploads/sites/2/2019/04/[email protected]" alt="Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions"></a>
61+
<a href="https://rtcamp.com/"><img src="https://rtcamp.com/wp-content/uploads/sites/2/2019/04/[email protected]" alt="Join us at rtCamp, we specialize in providing high performance enterprise WordPress solutions"></a>

0 commit comments

Comments
 (0)