Skip to content

Fix typos in documentation #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 23, 2017
Merged

Fix typos in documentation #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,9 @@ By clicking on the tray icon and going to the debug console you can try most of
log on

### List the boards
To get a json list of the connected boards you can issue the command list:
To get a json list of the connected boards you can issue the command:

```javascript
socket.emit('command', 'list');
```
list

You will receive an object of all the boards connected with USB or over the network:

Expand Down Expand Up @@ -264,7 +262,7 @@ The syntax of the command is:
downloadtool {{name}} {{version}} {{behaviour}}

where `version` can be a version number of the string "latest", and `behaviour` can be
"keep" (which skip the download if the tool already exists) and "replace" (which will download it again).
"keep" (which skips the download if the tool already exists) and "replace" (which will download it again).

### Upload
You can upload a binary sketch to a board connected to a port with a POST request to be made at the http endpoint.
Expand Down Expand Up @@ -293,13 +291,13 @@ The payload is a json object that looks like this:
}
```

- commandline is the command to execute to perform the upload. This is for example avrdude on a leonardo.
- commandline is the command to execute to perform the upload. This is, for example, avrdude on a Leonardo.

- hex contains the sketch hex encoded in base64

- signature is the signature of the commandline signed with the private key that matches the public key contained in the config.ini of the arduino-create-agent

The results of the upload will be delivered via websocket with messages that looks like:
The results of the upload will be delivered via websocket with messages that look like:

```json
{"Msg":"avrdude: verifying ...","ProgrammerStatus":"Busy"}
Expand Down Expand Up @@ -339,7 +337,7 @@ Your contribution is adding or modifying existing behaviour, please always refer

Be sure to use `go vet` and `go fmt` on every file before each commit: it ensures your code is properly formatted.

Also, for your contribution to be accepted, everyone of your commits must be "Signed-off". This is done by commiting using this command: `git commit --signoff`
Also, for your contribution to be accepted, every one of your commits must be "Signed-off". This is done by committing using this command: `git commit --signoff`

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.

Expand Down Expand Up @@ -384,5 +382,5 @@ By making a contribution to this project, I certify that:


## Creating a release
Just create a new release on github, and our drone server will build and upload
ithe compiled binaries for every architecture in a zip file in the release itself.
Just create a new release on GitHub, and our drone server will build and upload
the compiled binaries for every architecture in a zip file in the release itself.