Skip to content

Commit 49314bf

Browse files
Add short documentation
1 parent 0c34cb2 commit 49314bf

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1+
# MeVisLab Examples
2+
13
This is the repository for the MeVisLab Examples GitHub pages.
24

35
Please follow [Examples Pages](https://mevislab.github.io/examples/)
46

7+
8+
## Configuration
9+
10+
### Local Deployment
11+
* Checkout code
12+
* Install _extended_ hugo from the [Hugo Website](https://gohugo.io/)
13+
* Install npm e.g. from [npmjs Website](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
14+
* Change to mevislab.github.io folder and run `npm install`
15+
* Stay in this folder and run `hugo server -d public --baseURL //localhost/examples/` (The `/examples/` path is locally not absolute necessary but it helps to find problems that might appear on the production website.)
16+
* Open in your favorite browser the given URL

0 commit comments

Comments
 (0)