🔴 Update Project README
Make README.md the landing page for the finished project.
Previously
This assumes README.md has been drafted.
The README is the first page a visitor sees. Keep it short and point to the docs for the full story.
Step 1. Open README.md
With the project folder open in VS Code, open README.md for editing.
Markdown is a super-simple markup language. See Markdown Basics.
Step 2. Update Required Items
The README includes:
- your name or alias
- year and month
- Project Overview: what the project does and which problem was chosen
- Project Commands: how to set up and run the project
- at least one visual with evidence confirming the work
- common links at the end
- optional: badges
Update the overview to reflect your custom work.
Step 3. Write the Commands
List the commands as they need to be run, in order. Copy them from what worked.
Follow them as written, in a new terminal opened in the repository root, and confirm they work.
Step 4. Add a Visual
Use a visual saved in the repository, for example the one used in docs/index.md. Reference it with a path relative to README.md:
Step 5. Update the Links
The links at the end should include:
- the project documentation site
- the example project that was adapted
- the data source
Step 6. Optional Badges
Badges report information and sometimes live status from GitHub. For example, a badge indicating uv:
[](https://docs.astral.sh/uv/)
Step 7. Preview README
Locally: Open the Markdown preview of README.md in VS Code:
- Windows/Linux:
Ctrl + Shift + V - macOS:
Cmd + Shift + V
On GitHub: After the push, open the repository on GitHub and confirm the visual displays and the links open.
Verification
- [ ] README.md includes the name or alias, year and month, and an overview.
- [ ] The commands are listed and work when followed as written.
- [ ] README.md includes a visual that displays.
- [ ] The links to the docs, the example, and the data source open.
- [ ] No text from the example remains that does not describe this project.