origo-map / origo

Origo
Other
50 stars 55 forks source link

Readme file lacks description #4

Closed afogelberg closed 8 years ago

afogelberg commented 8 years ago

Currently there is no project description for Origo. This needs to be added.

markus659 commented 8 years ago

I can at least start by doing a draft/outline for the readme file, unless someone else has already started working on this issue?

afogelberg commented 8 years ago

Go for it!

markus659 commented 8 years ago

I've created a new branch for the updated readme-file. I added a few suggestions for headings. It is still missing a few things:

@afogelberg @jokd could you take a look at the updated readme?

afogelberg commented 8 years ago

Nice work @markus659 Looks really good. We have a license file, maybe we can point to that in the meantime? I think we should make the requirements section a bit more clear, node.js is required for development but not for deployment if using release (when we have one).

Please create a pull request and merge.

jokd commented 8 years ago

I think it looks great. Perhaps the links that are not yet valid should be removed to avoid confusing. @afogelberg has created a awesome logo :)

afogelberg commented 8 years ago

I will try to find the logo :) Agree with @jokd that it is best to remove the invalid links for now,

markus659 commented 8 years ago

Thank you for the feedback. I removed invalid links and references. I'm not sure what you meant by pointing to the license file @afogelberg, but I added a link to it. I also removed the "requirements" section for now.

afogelberg commented 8 years ago

Looks good to me!

afogelberg commented 8 years ago

Can we merge your branch @markus659 ? It looks good to me.

markus659 commented 8 years ago

Yes, you can go ahead and merge @afogelberg (you can remove the branch as well). I also added a link to Sigtunakartan and fixed the URL to Västerås Stads samlingskarta.