fisrt readme
[langlearn/.git] / README.md
1 # langlearn
2
3 > Let's practice! 
4 So, you are here looking for some practice, let;s begin then, in this project there are lots of ideas you can use to practice some programming, in any lang you want, you can even propose more challenges if you want or modify others projects.
5
6 So, in order to keep everything organized and gice credit to every coder we will not only mantain a special code structure but also a file that will server the porpuse of being our _database_ of participation. remember that you need a github account to participate.
7
8 ## Structure of the repo
9
10 + langlearn
11   + project
12     + lang
13       + contributor
14         + `files`
15
16 It's quite simple, just keep that format and we will be allrigt, just one more thing, you need to add a readme file in your repo so everyone knows exactly what are you pursuing with your personal project. Feel free to do as you please, it does not need to be just like other projects in that folder, or have the same goals.
17
18 ## `CONTRIBUTORS.md` format
19
20 Ok, basically the format that we will respect in the contributors file is a markdown file like so:
21
22 > \# contributors
23 >
24 > \#\# _{Project}_
25 >
26 > \#\#\# _{Lang}_
27 >
28 > \#\#\#\# _{contributor}_
29 >
30 > _decription and goal of the project_
31 >
32 > \> {other} {contributors} {names}
33 >
34 > \#\#\#\# _{contributor II}_
35 >
36 > _decription and goal of the project of contributor II_
37 >
38 > \> {other} {contributors} {names}
39