X Tutup
Skip to content

Commit 1c312d8

Browse files
author
AndreyGeonya
committed
fix readme.md
1 parent 0ba8028 commit 1c312d8

File tree

1 file changed

+27
-8
lines changed

1 file changed

+27
-8
lines changed

readme.md

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,43 @@ API reference with usage examples available <a href="https://mgechev.github.io/j
88

99
## Development
1010

11-
To install all dev dependencies use:
11+
**To install all dev dependencies**
12+
13+
Call:
1214

1315
```Bash
1416
npm install
1517
```
1618

17-
To setup documentation repository:
19+
**To setup repository with documentation**
20+
21+
1) go to the parent directory of the `javascript-algorithms` folder and call:
1822

19-
* go to the parent directory of the root of `javascript-algorithms`;
20-
* clone `javascript-algorithms` to directory called `javascript-algorithms-docs` (`git clone git@github.com:mgechev/javascript-algorithms.git javascript-algorithms-docs`);
21-
* change current branch in `javascript-algorithms-docs` to `gh-pages` (`git checkout gh-pages`).
23+
```Bash
24+
git clone git@github.com:mgechev/javascript-algorithms.git javascript-algorithms-docs
25+
```
2226

23-
To generate documentation call:
27+
2) go to the `javascript-algorithms-docs` folder and change current branch to `gh-pages`:
28+
29+
```Bash
30+
git checkout gh-pages
31+
```
32+
33+
Now you can see `index.html` file in this folder and open it in your browser.
34+
35+
**To update .html files with documentation**
36+
37+
Go to the `javascript-algorithms` folder and call:
38+
39+
```Bash
40+
gulp jsdoc
41+
```
2442

25-
`gulp jsdocs` inside `javascript-algorithms` folder. Content of the `javascript-algorithms-docs` will be updated and you will be able to look it in your browser.
43+
and all files in `javascript-algorithms-docs` folder will be updated.
2644

45+
**To run tests**
2746

28-
To run tests use:
47+
Call:
2948

3049
```Bash
3150
./node_modules/jasmine-node/bin/jasmine-node test/

0 commit comments

Comments
 (0)
X Tutup