search

csdojo-defaang / defaang

A website that will curate recently-asked interview questions from FAANG+. Currently inactive. Check out: https://github.com/ykdojo/OpenStream
MIT License
509 stars 120 forks source link

[DOCS] Move installation instructions to INSTALL.md #116

Open veganaize opened 2 years ago

veganaize commented 2 years ago

Description

How about moving the installation instructions from README.md into a file like INSTALL.md?

This would allow README.md to be much more concise -- a project description, table of contents, and highly relevant links (Discord, etc.)

AakashRaj20 commented 2 years ago

Description

How about moving the installation instructions from README.md into a file like INSTALL.md?

This would allow README.md to be much more concise -- a project description, table of contents, and highly relevant links (Discord, etc.)

Hi @veganaize I don't think that it is needed at this point of time

nateemerson commented 1 year ago

The current README.md weighs in at 90 LOC (lines of code) which doesn't strike me as too large at all. In fact, many repos have massive readmes that include everything about a library (take zod's 2224 line beast for example). Granted, the well structured table of contents definitely helps out.

I'll be honest, I'm not even sure it's necessary at this point (I might wait until >200 LOC), but one alternate resolution for this ticket could be an addition of a well-linked Table of Contents to README.md, which would perhaps make it more navigable for newcomers.