|
|
|
# Welcome
|
|
|
|
|
|
|
|
This is the sac2c compiler wiki home page.
|
|
|
|
|
|
|
|
This houses sac concepts, documentation, tutorials, new ideas etc.
|
|
|
|
Add missing or new information. The more we write down the better!
|
|
|
|
|
|
|
|
# How do I add to the wiki?
|
|
|
|
|
|
|
|
You can either edit the wiki on Gitlab or you can clone it and edit it on your own machine.
|
|
|
|
Click the `Clone repository` button in the top right or run:
|
|
|
|
|
|
|
|
```shell
|
|
|
|
git clone git@gitlab.sac-home.org:sac-group/sac2c.wiki.git
|
|
|
|
```
|
|
|
|
|
|
|
|
The directory structure should be flat and thus only go one directory deep.
|
|
|
|
Do not create directories in directories.
|
|
|
|
|
|
|
|
## Tips
|
|
|
|
|
|
|
|
- Use the `-` character in file names in place of space characters.
|
|
|
|
This works well with Gitlab as they are rendered as spaces.
|
|
|
|
You can also set a custom title [using yaml at the top of the file](). You can also set tags this way. Yaml is the most supported by other tools out of the options.
|
|
|
|
- Read [this](https://docs.gitlab.com/ee/user/markdown.html#wiki-specific-markdown) if you want to properly link to other files. There are a couple ways to do this. The easiest is the page [slug](https://en.wikipedia.org/wiki/Clean_URL#Slug).
|
|
|
|
|
