Skip to content

Commit 95cd2e6

Browse files
marcobarilarimarcobarilari
committed
Add first files to kick start this repo test
0 parents  commit 95cd2e6

File tree

9 files changed

+150
-0
lines changed

9 files changed

+150
-0
lines changed

‎.codespellrc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[codespell]
2+
skip = .git
3+
ignore-words-list = fo
4+
builtin = clear,rare

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*DS_Store

‎.pre-commit-config.yaml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
repos:
3+
4+
- repo: https://github.com/pre-commit/pre-commit-hooks
5+
rev: v4.6.0
6+
hooks:
7+
- id: trailing-whitespace
8+
- id: end-of-file-fixer
9+
- id: check-yaml
10+
- id: check-added-large-files
11+
12+
- repo: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt
13+
rev: 0.2.3
14+
hooks:
15+
- id: yamlfmt
16+
args: [--mapping, '2', --sequence, '2', --offset, '0']

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2021 Crossmodal Perception and Plasticity laboratory
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# CPP_LabGuide
2+
3+
This is a test

‎doc/contributing.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# CONTRIBUTING
2+
3+
Something is not clear or incorrenct or incomplete, something needs some updates over time or you found something new and cool that absolutely needs to be shared with the others... please contribute to this docs!!!
4+
5+
## Submit an issue (no git/github skills required)
6+
7+
Open an issue from [here](https://github.com/cpp-lln-lab/CPP_HPC/issues/new/choose) and try to be the most detailed possible.
8+
9+
## Make the changes your self (minor git/github skills required)
10+
11+
The actual text/scripts you find in this website are in this [repo](https://github.com/cpp-lln-lab/CPP_HPC) and in the `doc` folder [here](https://github.com/cpp-lln-lab/CPP_HPC/tree/main/doc)
12+
13+
Each article/section of the website is a specific markdown file with the same transparent name (more or less).
14+
15+
### Edit from github
16+
17+
Just find the the markdown file you want to edit (eg the one for this section [contributing.md](https://github.com/cpp-lln-lab/CPP_HPC/blob/main/doc/contributing.md)) and click on `edit` (the pen icon) on the top right.
18+
19+
When done, click on `commit changes` (green botton on the top right) and select `Create a new branch for this commit and start a pull request` and then `Commit changes`.
20+
21+
On the new opened page you can edit the title of the pull request to provide a more meaningful one, select a reviewer (highly reccomended!!!) and then finally create the pull request (PR).
22+
23+
If you fill confident you can then merge it right away or ask someone else to review the PR and then approve it with or without corrections and merge it.
24+
25+
To change the website strucute (change name to section, add sections or reorder them), see the file `mkdocs.yml` section `Pages`.
26+
27+
That's it!
28+
29+
### Edit locally
30+
31+
1. fork this repository
32+
2. clone your forked repository
33+
3. install the dependencies via:
34+
35+
```bash
36+
pip install -r requirements.txt
37+
```
38+
39+
4. create a branch
40+
5. make your changes in the respective markdown file in the `doc` folder
41+
6. visualize your changes by deploying a website preview via:
42+
43+
```bash
44+
mkdocs serve
45+
```
46+
47+
and view the preview here [http://127.0.0.1:8000/welcome](http://127.0.0.1:8000/welcome)
48+
49+
7. push your changes to your forked repository
50+
8. open a pull request

‎doc/index.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CPP Lab Guide
2+
3+
Lorem Ipsum
4+
5+
6+
## FAQ
7+
8+
What is the meaning of life? $2
9+
10+
## Contributing
11+
12+
To contribute see [here](https://cpp-lln-lab.github.io/CPP_LabGuide/contributing/)
13+

‎mkdocs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
# Project information
3+
site_name: CPP Lab Guide
4+
repo_name: cpp-lln-lab/CPP_LabGuide
5+
repo_url: https://github.com/cpp-lln-lab/CPP_LabGuide
6+
# docs_dir: alternative_path # docs/ is the default folder
7+
copyright: MIT
8+
9+
# This will use Material them
10+
theme:
11+
name: material
12+
language: en
13+
palette:
14+
primary: light blue
15+
accent: light blue
16+
features:
17+
- navigation.expand
18+
19+
docs_dir: doc
20+
21+
# Pages
22+
nav:
23+
- Welcome and FAQ: index.md
24+
- Contributing: contributing.md
25+
26+
# list of extension
27+
markdown_extensions:
28+
- admonition
29+
- pymdownx.details
30+
- toc:
31+
anchorlink: true
32+
permalink: '#'
33+
- pymdownx.tasklist:
34+
custom_checkbox: true
35+
36+
plugins:
37+
- include-markdown

‎requirements.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
mkdocs-material
2+
pymdown-extensions
3+
mkdocs-include-markdown-plugin
4+
pre-commit
5+
codespell

0 commit comments

Comments
 (0)