Have a proper README

[StefanBrand]

In order to enable others to use the map, for example with the URI parameters, we should come up with an explanatory README.

[Roboe]

YES. I want to make it since just after you created the repo, 😂

As you English is better than mine, can you start the writting work? I'll feel better suited reviewing it than writting it (I'm a [Spanish] proofreader/copyeditor after all).

[StefanBrand]

Since you have more experience in these things: What should a good README include? And what can't we miss, what has to be described in any case?

[Roboe]

I have some notes of a great talk @xuanxu gave us on h4ckademy:

Care your README file

• Describe project
• Installation instructions
• Status of the project
• Basic use case/example
• Contact info

README.md integrates with GitHub

Here are the complete notes: https://gitlab.com/snippets/26971

[xuanxu]

Happy to know you liked the talk, @Roboe! Here are the slides in case you find them useful: https://speakerdeck.com/xuanxu/how-to-manage-an-open-source-project

[Roboe]

I really liked it! Thank you for the slides! :smiley: :+1:

[StefanBrand]

Thank you for the notes and the slides! 😃

I will look into them and write something up in the following days.

[Roboe]

Since you already did the work of writing it in your fork, I've cherrypicked the commit and pushed it to the main repo, ;)

I'll close the issue now

[StefanBrand]

Thank you! Would have been an awful work for me to rebase my fork and create a PR. -- This message was sent from my Fairphone 1 with K-9 Mail.

Am 14. Dezember 2016 00:51:34 MEZ schrieb "Roberto M.F." notifications@github.com:

Since you already did the work of writing it in your fork, I've cherrypicked the commit and pushed it to the main repo, ;)