Add basic readme
dgzlopes opened this issue · 0 comments
dgzlopes commented
Right now the demo site has instructions, but I think that a basic readme could be useful for the people that see repo for the first time. Even if it's small... It is better than an empty repo!
For example, today I tried the project locally and spent a couple of minutes thinking: Why I can't see the wheel? Adding a small bit on the readme stating that a web server is needed (eg. python3 -m http.server) would be fantastic.
Also, It would make the instructions drier. Things like how to insert incidents and its format could be moved here.