Issue regarding Upadation of readme having correct setup procedure.

[sanjay-kv]

Discussed in #677

^{Originally posted by MuKulsoop October 8, 2024}
As the code is in the gh-pages branch. Can a issue be raised regarding updating the readme file having proper steps for the setup of the project in the local environment.
Like using command "git clone --branch gh-pages https://github.com/Username/awesome-github-profiles.git" to clone the code in the local environment ( for beginners ).

[yehiarasheed]

I can do this issue can you assign me for it

[Techbarsha]

Could you please assign me the task of updating the README with setup instructions.. I’ll include all steps attractively
also explain details about setup procedure
please assign @sanjay-kv

[yehiarasheed]

Just for clarity @sanjay-kv, you would like to change the steps in the README.md file on the main branch so that beginners can directly clone the working branch aka the gh-pages branch and start working on it right away with a command like git clone --branch gh-pages https://github.com/Username/awesome-github-profiles.git right?