Skip to content

Commit 25b5092

Browse files
author
Alice Pintus
committed
Merge pull request #16 from arduino/readme-update
Add contribution guidelines, move download links
2 parents 8d3e41a + ff212f0 commit 25b5092

File tree

1 file changed

+67
-6
lines changed

1 file changed

+67
-6
lines changed

README.md

+67-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,77 @@
11
arduino-create-agent
2-
=======================
2+
====================
33

44
Version X.XX
55

66
Get the latest version of the Agent for all supported platforms:
77

8-
| | | |
9-
| ------------- | ----------- | -------- |
10-
| Windows | [staging](http://downloads.arduino.cc/CreateBridge/ArduinoCreateAgent-1.0-windows-installer.exe) | [dev](http://downloads.arduino.cc/CreateBridge/staging/ArduinoCreateAgent-1.0-windows-installer.exe) |
11-
| MacOSX | [staging](http://downloads.arduino.cc/CreateBridge/ArduinoCreateAgent-1.0-osx-installer.dmg) | [dev](http://downloads.arduino.cc/CreateBridge/staging/ArduinoCreateAgent-1.0-osx-installer.dmg) |
12-
| Linux x64 | [staging](http://downloads.arduino.cc/CreateBridge/ArduinoCreateAgent-1.0-linux-x64-installer.run) | [dev](http://downloads.arduino.cc/CreateBridge/staging/ArduinoCreateAgent-1.0-linux-x64-installer.run) |
8+
* [Windows](http://downloads.arduino.cc/CreateBridge/ArduinoCreateAgent-1.0-windows-installer.exe)
9+
* [MacOSX](http://downloads.arduino.cc/CreateBridge/ArduinoCreateAgent-1.0-osx-installer.dmg)
10+
* [Linux x64](http://downloads.arduino.cc/CreateBridge/ArduinoCreateAgent-1.0-linux-x64-installer.run)
1311

1412
arduino-create-agent is a fork of @johnlauer's serial-port-json-server (which we really want to thank for his kindness and great work)
1513

1614
The history has been rewritten to keep the repo small (thus removing all binaries committed in the past)
15+
16+
# Contributing
17+
18+
Please use the current latest version:
19+
20+
* [Windows dev](http://downloads.arduino.cc/CreateBridge/staging/ArduinoCreateAgent-1.0-windows-installer.exe)
21+
* [MacOSX dev](http://downloads.arduino.cc/CreateBridge/staging/ArduinoCreateAgent-1.0-osx-installer.dmg)
22+
* [Linux x64 dev](http://downloads.arduino.cc/CreateBridge/staging/ArduinoCreateAgent-1.0-linux-x64-installer.run)
23+
24+
## Submitting an issue
25+
26+
Please attach the output of the commands running at http://localhost:8989 if useful.
27+
28+
## Submitting a pull request
29+
30+
We are glad you want to contribute with code: that's the best way to help this software.
31+
32+
Your contribution is adding or modifying existing behaviour, please always refer to an existing issue or open a new one before contributing. We are 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.
33+
34+
Be sure to use `go vet` and `go fmt` on every file before each commit: it ensures your code is properly formatted.
35+
36+
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`
37+
38+
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.
39+
40+
```
41+
Developer Certificate of Origin
42+
Version 1.1
43+
44+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
45+
660 York Street, Suite 102,
46+
San Francisco, CA 94110 USA
47+
48+
Everyone is permitted to copy and distribute verbatim copies of this
49+
license document, but changing it is not allowed.
50+
51+
52+
Developer's Certificate of Origin 1.1
53+
54+
By making a contribution to this project, I certify that:
55+
56+
(a) The contribution was created in whole or in part by me and I
57+
have the right to submit it under the open source license
58+
indicated in the file; or
59+
60+
(b) The contribution is based upon previous work that, to the best
61+
of my knowledge, is covered under an appropriate open source
62+
license and I have the right under that license to submit that
63+
work with modifications, whether created in whole or in part
64+
by me, under the same open source license (unless I am
65+
permitted to submit under a different license), as indicated
66+
in the file; or
67+
68+
(c) The contribution was provided directly to me by some other
69+
person who certified (a), (b) or (c) and I have not modified
70+
it.
71+
72+
(d) I understand and agree that this project and the contribution
73+
are public and that a record of the contribution (including all
74+
personal information I submit with it, including my sign-off) is
75+
maintained indefinitely and may be redistributed consistent with
76+
this project or the open source license(s) involved.
77+
```

0 commit comments

Comments
 (0)