Files & Configuration
README.md
What It Is
A file that explains what a project is and how to use it
Analogy
The instruction manual that comes with furniture — ideally you read it first
Try It Out
MarkdownREADME.md
| 1 | # My Awesome Project |
| 2 | |
| 3 | A brief description of what this project does. |
| 4 | |
| 5 | ## Getting Started |
| 6 | |
| 7 | ```bash |
| 8 | npm install |
| 9 | npm run dev |
| 10 | ``` |
| 11 | |
| 12 | ## Features |
| 13 | |
| 14 | - Feature 1 |
| 15 | - Feature 2 |
| 16 | - Feature 3 |
| 17 | |
| 18 | ## License |
| 19 | |
| 20 | MIT |
Related Terms in Files & Configuration
Dotfile
Secret notes you keep in a drawer. They're there, but you have to know to look for them
.env
A sticky note with passwords and settings you keep in your desk drawer — never in a shared folder
.env.local
Your personal sticky note that never leaves your desk, even if you share the project with others
.gitignore
A "do not pack" list for your suitcase — these items stay home no matter what