You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
19 lines
575 B
19 lines
575 B
2 years ago
|
# Explanation
|
||
|
|
|
||
|
|
This part of the project documentation focuses on a
|
||
|
|
**learning-oriented** approach. You'll learn how to
|
||
|
|
get started with the code in this project.
|
||
|
|
|
||
|
|
> **Note:** Expand this section by considering the
|
||
|
|
> following points:
|
||
|
|
|
||
|
|
- Help newcomers with getting started
|
||
|
|
- Teach readers about your library by making them
|
||
|
|
write code
|
||
|
|
- Inspire confidence through examples that work for
|
||
|
|
everyone, repeatably
|
||
|
|
- Give readers an immediate sense of achievement
|
||
|
|
- Show concrete examples, no abstractions
|
||
|
|
- Provide the minimum necessary explanation
|
||
|
|
- Avoid any distractions
|