

0 / 2 embers
0 / 3000 xp
click for more info
Complete a lesson to start your streak
click for more info
Still calibrating
click for more info
Not enough gems
Cost: 6 gems
1: Portfolio Projects
incomplete
2: How Many Projects?
incomplete
3: README Section
incomplete
4: Description Section
incomplete
5: Motivation Section
incomplete
6: Quick Start Section
incomplete
7: Usage Section
incomplete
8: Contributing Section
incomplete
Back
ctrl+,
Next
ctrl+.
This lesson's interactive features are locked, please to keep using them
If the reader is interested enough in the "what" and the "why", now it's time to show them "how"! This section should have the minimum number of steps they need to take to use your project.
Keep it as simple as possible! Here's an example:
## 🚀 Quick Start
### 1. Install zipzod using the Go toolchain
```bash
# Install Zipzod
go install github.com/xyz/zipzod@latest
# Compress an "input" Directory Into an "output.zip" File
zipzod -i ./input -o ./output.zip
```
Or, if your project is a deployed web application, it might be even simpler:
## 🚀 Quick Start
1. Navigate to [zipzod.xyz](https://zipzod.xyz) and upload your file!
2. Click the download link when it's done compressing!
If your project is hard to use, make it easier! If you've made it as easy as possible and it's still a pain in the butt, be sure that you have a video or GIF or something in addition to the quick start section in case the reader doesn't have time to try it out themselves.