Add a Readme to a Project You Have on GitHub

• 

  View of the README in the plan-my-walk repo.

Inspiration

I started working on a React project using an old coursework project originally written with JavaScript and no frameworks. One item missing from the project was a README file.

The challenge 'Add a Readme to a Project You Have on GitHub' was a perfect opportunity to start developing a README document that can grow as the application gets further developed.

What it does

Provides installation and running instructions.

How we built it

I used a template available at https://github.com/othneildrew/Best-README-Template. I filled in the sections using markdown and commented out irrelevant sections.

Challenges we ran into

Populating the README template was straightforward. Merging my current development branch into my main github branch in order to update the progress so far was less straight forward. However, now that essential running instructions have been provided, I can follow convention and close my development branch the next time I merge it with main! In future I think I would just wait to merge with main once all work is completed for the development branch.

Accomplishments that we're proud of

My understanding of markdown and git is improving.

What we learned

I learned to merge in an update on the command line.

What's next for Add a Readme to a Project You Have on GitHub

The README will be updated as the project develops.

Built With

• markdown