I am new to GitHub. I added my project to GitHub, but I have messed up my README.MD file. In my README.MD file I have described every step of my project. How can I organise it properly ?

https://github.com/yash251/crypto-zombies/blob/main/README.md

This is link to the README.MD file

CodePudding user response：

You can take a look at this article. It explains how to write a readme.

• https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes

• https://github.com/18F/open-source-guide/blob/18f-pages/pages/making-readmes-readable.md

CodePudding user response：

This is a Markdown file as the suffix .md tells you. Therefore, you need to actually use Markdown syntax to have proper styling of your page.

Have a look at GitHub's Basic writing and formatting syntax documentation.

Currently, your file basically looks like this:

// Step 1 - abc
// Step 2 - xyz
// Step 3 - uvw

... which is rendered as:

// Step 1 - abc // Step 2 - xyz // Step 3 - uvw

One way to fix this, is to use bullet points instead:

* Step 1 - abc
* Step 2 - xyz
* Step 3 - uvw

... which is rendered as:

• Step 1 - abc
• Step 2 - xyz
• Step 3 - uvw

CodePudding user response：

I took a stab at cleaning it up, I'd pay attention to @Matt's suggestion for the Markdown and run with it.