search

legorovers / pirover_simulator

A python based simulator for the 4tronix Inition and Pi2Go robots.
GNU General Public License v3.0
8 stars 40 forks source link

Add README file #9

Closed HaleemaLimbada closed 1 week ago

HaleemaLimbada commented 1 month ago

There is not currently a readme file. This would be useful for people who are new to the codebase

louiseadennis commented 1 month ago

Agreed - would you like to be assigned this?

Th0ught09 commented 1 month ago

I have a lot of experience in markdown, I'd like to if it's on offer? :)

HaleemaLimbada commented 1 month ago

That's fine with me if Louise assigns you to this.

louiseadennis commented 1 month ago

@Th0ught09 - It's all yours!

suzanneEmbury commented 1 month ago

There are some resources on how to write a good README file, @HaleemaLimbada . Here are some suggestions, in case they are useful.

https://github.com/hackergrrl/art-of-readme https://www.makeareadme.com

HaleemaLimbada commented 1 month ago

Thank you @suzanneEmbury! I'll have a look at them.