FCCColumbus / fcc-columbus

FreeCodeCamp Columbus
https://fcccolumbus.com/
MIT License
25 stars 15 forks source link

Extend README and make it newbie-friendly #18

Open DanStockham opened 7 years ago

DanStockham commented 7 years ago

Right now, the current documentation helps when setting up the project and environment. However, newer users may still get lost after setting up the environment and start coding. Therefore, we should explain more after the user sets up the project. Include a file structure and highlight directories the user would be working mostly in.

Just some thoughts...

jwoo92 commented 7 years ago

To add to this thought, it might not be a bad idea to have a small section that helps others setup linters on their preferred choice of text editor (e.g. Sublime, Atom, etc.). We have it built into the project, but it is nice to have in the text editor as well, which unfortunately is not an out of the box feature for most.

I also have a few sublime snippets I can share if you guys think it would be helpful.

List of sublime snippets:

Kenttleton commented 6 years ago

Per slack discussion and my thoughts:

Kenttleton commented 6 years ago

After reading these again and thinking this could also be written as a wiki as well.