Skip to content

Commit a0c81f0

Browse files
committed
Fix Markdownlint error & Fix links
1 parent 3551402 commit a0c81f0

File tree

22 files changed

+185
-78
lines changed

22 files changed

+185
-78
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# V by Example
22

3-
[Brazilian Portuguese](pt-br/README.md) | [Deutsch](de/README.md) | [English](README.md)
4-
3+
[Brazilian Portuguese](/pt-br/README.md) | [Deutsch](/de/README.md) | [English](README.md) | [Bahasa Indonesia](/id/README.md)
54
> Learn V by Examples
65
76
V by Example is a direct introduction to V by using annotated program examples.

de/CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
3+
## General
4+
5+
Please ensure your pull request adheres to the following guidelines:
6+
7+
* New example or improvements to existing examples are welcome.
8+
* Please check your spelling and grammar.
9+
10+
## Adding a New Example
11+
12+
To add a new example, create a new folder and a file or a file (depending upon the example) under the appropriate directory in `./examples`. Please check the `.plan` file to see what examples we plan to create. Feel free to work on any pending examples. We're happy to read/review your changes and collaborate/code with you to merge them.
13+
14+
Thank you for your contributions!
15+
16+
## Getting started with the project
17+
18+
### 1. Fork and clone this repository
19+
20+
[Fork this repository](https://github.com/v-community/v_by_example/fork) and clone your fork. If you don't know what forking means or don't know how to do it, nice instructions are available [here](https://help.github.com/articles/fork-a-repo/).
21+
22+
#### 2. Make your changes and push them
23+
24+
Now you're ready to make your changes! Once you're done with your changes, push those changes to your fork and then [submit a **pull request**](https://help.github.com/articles/using-pull-requests/).
25+
26+
## License
27+
28+
This code is free to use under the terms of the MIT license.

de/README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# V mit einem Beispiel
22

3-
[Brazilian Portuguese](../pt-br/) \| [Deutsch](./) \| [English](../)
3+
[Brazilian Portuguese](/pt-br/README.md) | [Deutsch](README.md) | [English](/README.md) | [Bahasa Indonesia](/id/README.md)
44

55
> Learn V by Examples
66
77
V by Example ist eine Einführung in V anhand von begleitenden, erklärten Codebeispielen.
88

9-
* [Beispiele](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/examples/README.md)
10-
* [Contributing](./#contributing)
11-
* [License](./#license)
9+
* [Beispiele](examples/README.md)
10+
* [Contributing](#contributing)
11+
* [License](#license)
1212

1313
Discord: [https://discord.gg/d3Qk65J](https://discord.gg/d3Qk65J)
1414

@@ -29,26 +29,26 @@ Dieses Kapitel behandelt bedingte Anweisungen, Schleifen und andere wichtige Ope
2929

3030
* [Operatoren](examples/section_2/operator.md)
3131
* [If-else](examples/section_2/if-else.md)
32-
* [Match](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_2/match.md)
33-
* [Schleifen](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_2/loops.md)
32+
* [Match](examples/section_2/match.md)
33+
* [Schleifen](examples/section_2/loops.md)
3434

3535
## Kaptiel 3
3636

3737
Hier wird die wichtigste Datenstruktur in V behandelt: `Array`s und `Struct`s. Beinhaltet sind weiterhin Beispiele und Erklärungen zu den Themen Funktionen und Methoden.
3838

39-
* [Funktionen](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_3/functions.md)
40-
* [Arrays](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_3/arrays.md)
41-
* [Struct](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_3/struct.md)
42-
* [Methoden](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_3/methods.md)
39+
* [Funktionen](examples/section_3/functions.md)
40+
* [Arrays](examples/section_3/arrays.md)
41+
* [Struct](examples/section_3/struct.md)
42+
* [Methoden](examples/section_3/methods.md)
4343

4444
## Kapitel 4
4545

4646
In diesem Kapitel werden Arrays noch einmal vertieft. Es wird hier auch auf das Format `JSON` eingegangen, der Bereich Dateioperationen \(lesen und schreiben\), sowie Testing gezeigt.
4747

48-
* [Array Funktionen](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_4/array-functions.md)
49-
* [Testing](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_4/testing.md)
50-
* [File-IO](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_4/files.md)
51-
* [JSON](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/de/examples/section_4/json.md)
48+
* [Array Funktionen](examples/section_4/array-functions.md)
49+
* [Testing](examples/section_4/testing.md)
50+
* [File-IO](examples/section_4/files.md)
51+
* [JSON](examples/section_4/json.md)
5252

5353
## Team
5454

@@ -62,9 +62,8 @@ Derzeitige Liste der Autoren/Maintainer
6262

6363
## Contributing
6464

65-
Um etwas beizutragen einfach den [Contributing-Guide](contributing.md) lesen, die Schritte befolgen und los geht's! Wir wählen Maintainer aufgrund ihrer Beiträge zum Projekt aus.
65+
Um etwas beizutragen einfach den [Contributing-Guide](CONTRIBUTING.md) lesen, die Schritte befolgen und los geht's! Wir wählen Maintainer aufgrund ihrer Beiträge zum Projekt aus.
6666

6767
## Lizenz
6868

69-
[MIT](https://github.com/v-community/v_by_example/tree/73c4624c87adba104b8015caaf7e04cd7426732f/de/LICENSE/README.md)
70-
69+
[MIT](/LICENSE)

de/examples/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# examples
2-
1+
# Examples

de/examples/section_1/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# section\_1
2-
1+
# Section 1

de/examples/section_2/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# section\_2
2-
1+
# Section 2

de/examples/section_3/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# section\_3
2-
1+
# Section 3

de/examples/section_4/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# section\_4
2-
1+
# Section 4

en/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# en
2-
1+
# Examples

en/examples/README.md

Lines changed: 69 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,69 @@
1-
# examples
2-
1+
# V by Example
2+
3+
[Brazilian Portuguese](pt-br/README.md) | [Deutsch](de/README.md) | [English](README.md)
4+
5+
> Learn V by Examples
6+
7+
V by Example is a direct introduction to V by using annotated program examples.
8+
9+
- [Examples](#examples)
10+
- [Contributing](#contributing)
11+
- [License](#license)
12+
13+
Discord: [https://discord.gg/d3Qk65J](https://discord.gg/d3Qk65J)
14+
15+
## Section 1
16+
17+
Introduction to V by presenting a few basic examples and exercises.
18+
19+
- [Hello World](en/examples/section_1/hello_world.md)
20+
- [V Keywords](en/examples/section_1/keywords.md)
21+
- [Primitives](en/examples/section_1/primitives.md)
22+
- [Variables](en/examples/section_1/variables.md)
23+
- [Strings](en/examples/section_1/strings.md)
24+
- [Comment](en/examples/section_1/comment.md)
25+
26+
## Section 2
27+
28+
This section discusses the main operators and conditional statements in V.
29+
30+
- [Operator](en/examples/section_2/operator.md)
31+
- [If-else](en/examples/section_2/if-else.md)
32+
- [Match](en/examples/section_2/match.md)
33+
- [Loops](en/examples/section_2/loops.md)
34+
35+
## Section 3
36+
37+
A study on functions and methods and in the most important data structures in V: arrays and struct.
38+
39+
- [Functions](en/examples/section_3/functions.md)
40+
- [Arrays](en/examples/section_3/arrays.md)
41+
- [Struct](en/examples/section_3/struct.md)
42+
- [Methods](en/examples/section_3/methods.md)
43+
44+
## Section 4
45+
46+
In this section, we dive deeper and study the features inside the Array object. Other examples like JSON, Writing/reading files and Testing are covered.
47+
48+
- [Array Functions](en/examples/section_4/array-functions.md)
49+
- [Testing](en/examples/section_4/testing.md)
50+
- [Files](en/examples/section_4/files.md)
51+
- [JSON](en/examples/section_4/json.md)
52+
53+
## Team
54+
55+
Current list of maintainers/authors:
56+
57+
- [Don Alfons Nisnoni](https://github.com/dhonx)
58+
- [Ivo-Balbaert](https://github.com/ibalbaert)
59+
- [Sven Patrick Meier](https://github.com/SuicideS3ason)
60+
- [Swastik Baranwal](https://github.com/Delta456)
61+
- [Vitor Oliveira](https://github.com/vbrazo)
62+
63+
## Contributing
64+
65+
See our [CONTRIBUTING.md](CONTRIBUTING.md) and start contributing today. We usually elect new maintainers based on contributions.
66+
67+
## License
68+
69+
[MIT](LICENSE)

0 commit comments

Comments
 (0)