From 6a7dfbf7c1daf22c3df8e1a196858d2cc5a06163 Mon Sep 17 00:00:00 2001 From: Josue Rodriguez Date: Tue, 3 Nov 2020 14:04:56 -0500 Subject: [PATCH] fisrt readme --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index f2a1e6d..2982782 100644 --- a/README.md +++ b/README.md @@ -1 +1,39 @@ # langlearn + +> Let's practice! +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. + +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. + +## Structure of the repo + ++ langlearn + + project + + lang + + contributor + + `files` + +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. + +## `CONTRIBUTORS.md` format + +Ok, basically the format that we will respect in the contributors file is a markdown file like so: + +> \# contributors +> +> \#\# _{Project}_ +> +> \#\#\# _{Lang}_ +> +> \#\#\#\# _{contributor}_ +> +> _decription and goal of the project_ +> +> \> {other} {contributors} {names} +> +> \#\#\#\# _{contributor II}_ +> +> _decription and goal of the project of contributor II_ +> +> \> {other} {contributors} {names} +> -- 2.25.1