Skip to content

Commit 107c72d

Browse files
committed
Add content to REAMDE
1 parent a2423aa commit 107c72d

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

README.md

+48-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,49 @@
1-
SimScale SDK Tutorial
2-
=====================
1+
# SimScale SDK Tutorial
32

4-
SimScale SDK Tutorial
3+
Sources for the public SimScale SDK Tutorial.
4+
5+
The generated tutorial website can be found in the following address:
6+
7+
[https://simscalegmbh.github.io/simscale-sdk-tutorial/](https://simscalegmbh.github.io/simscale-sdk-tutorial/)
8+
9+
## Development
10+
11+
This project is developed using the [Sphinx](https://www.sphinx-doc.org/en/master/index.html) documentation tool.
12+
13+
In order to build the HTML locally, first setup your dev environment:
14+
15+
1. Clone the repo and enter the folder
16+
17+
```bash
18+
git clone https://github.com/SimScaleGmbH/simscale-sdk-tutorial.git
19+
20+
cd simscale-sdk-tutorial
21+
```
22+
23+
2. Create and activate a virtual environment, in this case using [virtualenv](https://virtualenv.pypa.io/en/latest/)
24+
25+
```bash
26+
virtualenv venv
27+
28+
. venv/bin/activate
29+
```
30+
31+
3. Install the prerequisites
32+
33+
```bash
34+
pip install -r requirements.txt
35+
```
36+
37+
Now you are ready to build the MTHL page locally:
38+
39+
```bash
40+
make html
41+
```
42+
43+
You will find the generated website in the `_build/html/` folder. If you open the `index.html` file located inside that folder with your browser, you should be able to visualize the generated website.
44+
45+
## Contribute
46+
47+
If you wish to contribute, please feel free to submit a Pull Request or create an Issue.
48+
49+
The content of the tutorial is added in [reStructuredText](https://sublime-and-sphinx-guide.readthedocs.io/en/latest/index.html) format, in the corresponding `.rst` files, found inside the `tutorial` and `advanced` folders.

0 commit comments

Comments
 (0)