Skip to content

Commit 8b9ab21

Browse files
authored
Linted README.md (#764)
1 parent dce3afb commit 8b9ab21

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# arduino-create-agent
2+
13
[![License: AGPL v3.0](https://img.shields.io/badge/License-AGPL%20v3.0-blue)](https://www.gnu.org/licenses/agpl-3.0.html)
24
[![Test Go status](https://github.com/arduino/arduino-create-agent/actions/workflows/test-go-task.yml/badge.svg)](https://github.com/arduino/arduino-create-agent/actions/workflows/test-go-task.yml)
35
[![Codecov](https://codecov.io/gh/arduino/arduino-create-agent/branch/main/graph/badge.svg)](https://codecov.io/gh/arduino/arduino-create-agent)
@@ -6,13 +8,11 @@
68
[![Check Go Dependencies status](https://github.com/arduino/arduino-create-agent/actions/workflows/check-go-dependencies-task.yml/badge.svg)](https://github.com/arduino/arduino-create-agent/actions/workflows/check-go-dependencies-task.yml)
79
[![Check Go status](https://github.com/arduino/arduino-create-agent/actions/workflows/check-go-task.yml/badge.svg)](https://github.com/arduino/arduino-create-agent/actions/workflows/check-go-task.yml)
810

9-
arduino-create-agent
10-
====================
11-
1211
The Arduino Create Agent is a single binary that will sit on the traybar and work in the background. It allows you to use the [Arduino Create applications](https://create.arduino.cc) to seamlessly upload code to any USB connected Arduino board (or Yún in LAN) directly from the browser.
1312

1413
## Architecture
15-
```
14+
15+
```text
1616
+-------------------------------+
1717
| |
1818
| Browser |
@@ -26,13 +26,17 @@ The Arduino Create Agent is a single binary that will sit on the traybar and wor
2626
```
2727

2828
## Installation
29+
2930
Get the [latest version](https://github.com/arduino/arduino-create-agent/releases) of the Agent for all supported platforms or complete the [Getting Started](https://create.arduino.cc/getting-started/plugin/welcome).
3031

3132
## Apple M1 support
33+
3234
At the moment the new Apple Silicon Macs released in November 2020, like the [MacBook Pro 13"](https://www.apple.com/macbook-pro-13/), [MacBook Air](https://www.apple.com/macbook-air/) and [Mac mini](https://www.apple.com/mac-mini/) models with the [Apple M1](https://www.apple.com/mac/m1/) chip do not have native builds. But the Arduino Agent performs well in [Rosetta 2 mode](https://support.apple.com/en-us/HT211861).
3335

3436
## Documentation
37+
3538
The documentation has been moved to the [wiki](https://github.com/arduino/arduino-create-agent/wiki) page. There you can find:
39+
3640
- [Advanced usage](https://github.com/arduino/arduino-create-agent/wiki/Advanced-usage): explaining how to use multiple configurations and how to use the agent with a proxy.
3741
- [Agent Beta Program](https://github.com/arduino/arduino-create-agent/wiki/Agent-Beta-Program)
3842
- [Developement](https://github.com/arduino/arduino-create-agent/wiki/Developement): containing useful info to help in development
@@ -42,6 +46,7 @@ The documentation has been moved to the [wiki](https://github.com/arduino/arduin
4246
- [How to use the agent](https://github.com/arduino/arduino-create-agent/wiki/How-to-use-the-agent)
4347

4448
## Contributing
49+
4550
### Submitting an issue
4651

4752
When submitting a new issue please search for duplicates before creating a new one. Help us by providing useful context and information. Please attach the output of the commands running at the debug console or attach [crash reports](https://github.com/arduino/arduino-create-agent/wiki/How-to-use-crashreport-functionality) if useful.
@@ -55,6 +60,7 @@ Thank you!
5560
e-mail contact: [email protected]
5661

5762
### Submitting a pull request
63+
5864
We are glad you want to contribute with code: that's the best way to help this software.
5965

6066
Your contribution is adding or modifying existing behaviour, please always refer to an existing issue or open a new one before contributing. We are trying to use [Test Driven Development](https://en.wikipedia.org/wiki/Test-driven_development) in the near future: please add one or more tests that prove that your contribution is good and is working as expected, it will help us a lot.
@@ -66,12 +72,14 @@ Also, for your contribution to be accepted, every one of your commits must be "S
6672
By signing off your commits, you agree to the following agreement, also known as [Developer Certificate of Origin](http://developercertificate.org/): it assures everyone that the code you're submitting is yours or that you have rights to submit it.
6773

6874
## Authors and acknowledgment
75+
6976
arduino-create-agent is a fork of @[johnlauer](https://github.com/johnlauer)'s [serial-port-json-server](https://github.com/johnlauer/serial-port-json-server) (which we really want to thank for his kindness and great work)
7077

7178
The history has been rewritten to keep the repo small (thus removing all binaries committed in the past)
7279

7380
## License
74-
```
81+
82+
```text
7583
Developer Certificate of Origin
7684
Version 1.1
7785
@@ -82,7 +90,6 @@ San Francisco, CA 94110 USA
8290
Everyone is permitted to copy and distribute verbatim copies of this
8391
license document, but changing it is not allowed.
8492
85-
8693
Developer's Certificate of Origin 1.1
8794
8895
By making a contribution to this project, I certify that:

0 commit comments

Comments
 (0)