Skip to content

Commit 2bca894

Browse files
committed
Added readme file to the docs directory.
1 parent 76b9fd6 commit 2bca894

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

docs/readme.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# GitVersion Documentation
2+
3+
This is the directory in which the
4+
[GitVersion documentation hosted on ReadTheDocs](http://gitversion.readthedocs.io/en/latest/)
5+
resides.
6+
7+
## Contributing
8+
9+
Improvements to the documentation is highly welcomed and is as easy
10+
as finding the `.md` file you want to change and editing it directly within
11+
GitHub's web interface.
12+
13+
If you want to do more elaborate changes, we would appreciate if you could test
14+
the documentation locally before submitting a pull request. This involves
15+
[forking](https://guides.github.com/activities/forking/) this repository and
16+
then serving up the documentation locally on your machine, clicking around in
17+
it to ensure that everything works as expected.
18+
19+
## Serving the documentation locally
20+
21+
To serve up the documentation locally, you need to
22+
[install MkDocs](http://www.mkdocs.org/#installation) and then at the root of
23+
the GitVersion project write the following in a command line window:
24+
25+
```shell
26+
mkdocs serve
27+
```
28+
29+
After pressing enter, something similar to the following lines should appear:
30+
31+
```
32+
INFO - Building documentation...
33+
INFO - Cleaning site directory
34+
[I 160810 10:48:18 server:281] Serving on http://127.0.0.1:8000
35+
```
36+
37+
If it says `Serving on http://127.0.0.1:8000`, you should be able to navigate
38+
your favorite browser to `http://127.0.0.1:8000` and browse the documentation
39+
there. If you have any problems with this process, please consult the
40+
[MkDocs documentation](http://www.mkdocs.org/).

0 commit comments

Comments
 (0)