Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README for each unit #2

Open
mcouplet opened this issue Apr 5, 2016 · 4 comments
Open

README for each unit #2

mcouplet opened this issue Apr 5, 2016 · 4 comments

Comments

@mcouplet
Copy link
Contributor

mcouplet commented Apr 5, 2016

For each unit, we should have a README that will show automatically and contains the following information:

  • brief overview of the content
  • reference to section in Green Book
  • prerequisites for the unit (see Prerequisites  #1)
  • problems to solve (increasing order of difficulty)

See unit 13 as an example.
Could each of you that created a unit write a README? I think it will be helpful for contestants.

@RobinJadoul
Copy link
Member

I believe it is possible to just use relative links, such that github will resolve them itself, instead of hardcoding the github link

@mcouplet
Copy link
Contributor Author

mcouplet commented Apr 5, 2016

@RobinJadoul alright, thanks for the remark.

@vlecomte
Copy link
Contributor

I've added a README for my units and a general README for the repo, tell me what you think.

In terms of unit READMEs, the only ones that are still missing afaik are the ones for units 3 and 19. We are also missing a Dutch translation for the description in unit 2.

@mcouplet
Copy link
Contributor Author

@vlecomte Great, this repo starts to look very professional :)
I think we should translate the main README in French and Dutch, so that the younger ones feel welcome. I propose the very basic units (like 1,2,3,4,6) are completely translated (README + slides) and we leave the rest in English.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants