Skip to content

Commit 333ce2f

Browse files
committed
docs: tidy up README and user documentation formatting
1 parent a501b36 commit 333ce2f

File tree

3 files changed

+5
-6
lines changed

3 files changed

+5
-6
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@
99
[![Test Go status](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml/badge.svg)](https://github.com/arduino/arduino-app-cli/actions/workflows/go-test.yml)
1010

1111
## Docs
12+
1213
For guidance on installation and development, see the [User documentation].
1314

1415
## Quickstart
16+
1517
// TODO
1618

1719
## How to contribute
@@ -23,7 +25,6 @@ contribute your changes to the project.
2325

2426
:sparkles: Thanks to all our [contributors]! :sparkles:
2527

26-
2728
## Security
2829

2930
If you think you found a vulnerability or other security-related bug in the Arduino CLI, please read our [security
@@ -40,9 +41,7 @@ is mandatory if you want to modify or otherwise use the software for commercial
4041
software without disclosing the source code of your own applications. To purchase a commercial license, send an email to
4142
license@arduino.cc
4243

43-
44-
[user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md
44+
[user documentation]: https://github.com/arduino/arduino-app-cli/docs/user-documentation.md
4545
[how to contribute]: https://arduino.github.io/arduino-app-cli/latest/CONTRIBUTING/
4646
[security policy]: https://github.com/arduino/arduino-app-cli/security/policy
4747
[contributors]: https://github.com/arduino/arduino-cli/graphs/contributors
48-

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
## TODO
1+
## TODO

docs/user-documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
21
## Environment Variables
2+
33
The following environment variables are used to configure `arduino-app-cli`:
44

55
### Application Directories

0 commit comments

Comments
 (0)