[EPIC] One for all - Documentation for users and contributors

[umamaistempo]

Description

Things to be done to improve quality of life for future contributors and users, like documentation, instructions etc

Tasks

• [ ] #70 Chose, configure and implement coverage test
• [ ] #98 Write README.md
• [ ] #177 Write CONTRIBUTING.md
• [ ] #178 Write style guide
• [ ] #179 Document throughly new folder organization

[TheHeroBrine422]

Yay! Please do this quickly, I have wanted to start getting familiar with the code and I can't because it is hard for me to understand it

[umamaistempo]

@TheHeroBrine422 thanks for your input, i'll do my best to properly document the code ASAP.

Out of curiosity: are you already used to erlang/elixir ? If not, i might recommend you some good sources shall you want it :)

[TheHeroBrine422]

I would love some sources. I have never played around with it but I already know some other languages so I figured I could learn it pretty quickly.

[umamaistempo]

1. Elixir's Getting Started tutorial The elixir official tutorial on getting started with elixir: the syntax, the data structures etc
2. Saša Jurić's Elixir in Action Is a great introductory book on elixir and it touches intermediate subjects. It'll be useful to get used to elixir's syntax, data structures and to grasp how to program in a concurrency-oriented functional programming language.
3. Joe Armstrong's Programming Erlang This book is written by one of Erlang creators. It explains why erlang is the way it is, what is implied on concurrency-oriented programming, why it makes sense to have actors etc. It's a great book to get familiar with OTP (the plataform that implements erlang, and, by consequence, elixir) and to grok how process communication works.
4. Fred Herbert's Learn You Some Erlang for great good! It is basically an enormous collection of easy-to-read tutorials on how to use the erlang environment, why things work the way they do, programming techniques etc. A must read to grok erlang

Note that, as you may have noticed, most sources have intersection on some topics. See them as complimentary :)

[TheHeroBrine422]

Thanks for all the help. Hopefully, by the time I read this stuff and start using it in practice, you guys will have this stuff done so I can start getting familiar with the code!