documentation/readme.md

85 lines
2.3 KiB
Markdown
Raw Normal View History

2021-04-02 11:30:24 +02:00
# This is my documentation for the best course ever
2021-04-01 12:12:12 +02:00
2021-04-01 13:44:08 +02:00
## Matrix
2021-04-01 13:55:42 +02:00
All communication during the course will be done via [matrix](https://matrix.org/).
You can create an account on our own [local server](https://riot.86thumbs.net/) or choose one of the many providers online.
A *non exhaustive list* can be seen below.
* [nerdsin.space](https://nerdsin.space/#/welcome)
* [matrix.org](https://app.element.io/)
* the bxl [hackerspace](https://app.element.io/) offers accounts too
2021-04-01 13:44:08 +02:00
## Git
Git is a versioning system.
More information can be found on the [main](https://git-scm.com/) website.
A general overview of *how* git works can be seen in th diagram below.
2021-04-02 09:59:05 +02:00
![diagram git](images/git_diagram.png)
2021-04-01 13:44:08 +02:00
2021-04-01 15:26:56 +02:00
### Gitea
You can log in to our personal gitea [here](https://gitea.86thumbs.net).
2021-04-02 14:02:44 +02:00
Feel free to make as many repositories as you want to!
If you want to try out how multiple accounts work together you can create secondary accounts for yourself as well, or invite someone from class to test things out together.
2021-04-02 09:59:05 +02:00
2021-04-02 14:02:44 +02:00
### Practice
2021-04-02 10:07:40 +02:00
2021-04-02 14:02:44 +02:00
As practice you can do the following two exercizes.
I would advise to start with the first one.
Once you understand how branches work you could try the second game which is more riddles than git.
2021-04-02 16:12:19 +02:00
The third exercize is fully online and was an in class suggestion.
2021-04-02 14:02:44 +02:00
* [fracz](https://gitexercises.fracz.com/)
* [git-game](https://github.com/git-game/git-game)
2021-04-02 16:12:19 +02:00
* fully [online](https://www.katacoda.com/courses/git/1) exercizes
2021-04-02 14:02:44 +02:00
While doing the exercizes it is a *good* idea to keep track of the documentation and tutorials you find online.
At the bare minimum, make a list of links for future reference.
A more complete approach would be to create dedicated paragraphs for each exercize.
2021-04-02 10:11:23 +02:00
2021-04-02 16:12:19 +02:00
### Fracz
#### EX 1
This is a pretty simple one.
There is a commit waiting to be pushed, all you have to do is push it.
Remember, with this game it's not **push** but **verify**.
```
git verify
```
Once you verify and the solution is passed, you can go to the next exercize by executing:
```
git start next
```
If at some point you mess up, you can restart the exercize by typing:
```
git start
```
#### EX 2
Only add one file to the repository.
A quick tutorial on how to add files can be found [here](.
#### EX 3
#### EX 4
#### EX 5
#### EX 6
#### EX 7
#### EX 8
#### EX 9