Skip to content
This repository was archived by the owner on Oct 22, 2021. It is now read-only.

Commit 929954c

Browse files
mastrolinuxRoberto Sora
mastrolinux
authored and
Roberto Sora
committed
General docs about the project (#1)
* General docs about the project * 'Added contribution mentioning' * Added copyright info * Fixed typos and Copyright notice
1 parent 204a50f commit 929954c

File tree

3 files changed

+316
-0
lines changed

3 files changed

+316
-0
lines changed

‎CONTRIBUTIONS.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Contributions
2+
Copyright (c) 2019 ARDUINO SA (www.arduino.cc)
3+
The Arduino Pro IDE is an Arduino® project developed by the Arduino team and some partners, the main contributors are:
4+
5+
* Arduino CLI Team: https://github.com/arduino/arduino-cli/graphs/contributors
6+
* TypeFox Team: https://www.typefox.io/

‎LICENSE.md

+285
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,285 @@
1+
This file includes licensing information for arduino-pro-editor
2+
3+
Copyright (c) 2019 ARDUINO SA (www.arduino.cc)
4+
5+
This program and the accompanying materials are made available under the
6+
terms of the Eclipse Public License v. 2.0 which is available at
7+
http://www.eclipse.org/legal/epl-2.0
8+
9+
# Eclipse Public License - v 2.0
10+
11+
THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE
12+
PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION
13+
OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
14+
15+
1. DEFINITIONS
16+
17+
"Contribution" means:
18+
19+
a) in the case of the initial Contributor, the initial content
20+
Distributed under this Agreement, and
21+
22+
b) in the case of each subsequent Contributor:
23+
i) changes to the Program, and
24+
ii) additions to the Program;
25+
where such changes and/or additions to the Program originate from
26+
and are Distributed by that particular Contributor. A Contribution
27+
"originates" from a Contributor if it was added to the Program by
28+
such Contributor itself or anyone acting on such Contributor's behalf.
29+
Contributions do not include changes or additions to the Program that
30+
are not Modified Works.
31+
32+
"Contributor" means any person or entity that Distributes the Program.
33+
34+
"Licensed Patents" mean patent claims licensable by a Contributor which
35+
are necessarily infringed by the use or sale of its Contribution alone
36+
or when combined with the Program.
37+
38+
"Program" means the Contributions Distributed in accordance with this
39+
Agreement.
40+
41+
"Recipient" means anyone who receives the Program under this Agreement
42+
or any Secondary License (as applicable), including Contributors.
43+
44+
"Derivative Works" shall mean any work, whether in Source Code or other
45+
form, that is based on (or derived from) the Program and for which the
46+
editorial revisions, annotations, elaborations, or other modifications
47+
represent, as a whole, an original work of authorship.
48+
49+
"Modified Works" shall mean any work in Source Code or other form that
50+
results from an addition to, deletion from, or modification of the
51+
contents of the Program, including, for purposes of clarity any new file
52+
in Source Code form that contains any contents of the Program. Modified
53+
Works shall not include works that contain only declarations,
54+
interfaces, types, classes, structures, or files of the Program solely
55+
in each case in order to link to, bind by name, or subclass the Program
56+
or Modified Works thereof.
57+
58+
"Distribute" means the acts of a) distributing or b) making available
59+
in any manner that enables the transfer of a copy.
60+
61+
"Source Code" means the form of a Program preferred for making
62+
modifications, including but not limited to software source code,
63+
documentation source, and configuration files.
64+
65+
"Secondary License" means either the GNU General Public License,
66+
Version 2.0, or any later versions of that license, including any
67+
exceptions or additional permissions as identified by the initial
68+
Contributor.
69+
70+
2. GRANT OF RIGHTS
71+
72+
a) Subject to the terms of this Agreement, each Contributor hereby
73+
grants Recipient a non-exclusive, worldwide, royalty-free copyright
74+
license to reproduce, prepare Derivative Works of, publicly display,
75+
publicly perform, Distribute and sublicense the Contribution of such
76+
Contributor, if any, and such Derivative Works.
77+
78+
b) Subject to the terms of this Agreement, each Contributor hereby
79+
grants Recipient a non-exclusive, worldwide, royalty-free patent
80+
license under Licensed Patents to make, use, sell, offer to sell,
81+
import and otherwise transfer the Contribution of such Contributor,
82+
if any, in Source Code or other form. This patent license shall
83+
apply to the combination of the Contribution and the Program if, at
84+
the time the Contribution is added by the Contributor, such addition
85+
of the Contribution causes such combination to be covered by the
86+
Licensed Patents. The patent license shall not apply to any other
87+
combinations which include the Contribution. No hardware per se is
88+
licensed hereunder.
89+
90+
c) Recipient understands that although each Contributor grants the
91+
licenses to its Contributions set forth herein, no assurances are
92+
provided by any Contributor that the Program does not infringe the
93+
patent or other intellectual property rights of any other entity.
94+
Each Contributor disclaims any liability to Recipient for claims
95+
brought by any other entity based on infringement of intellectual
96+
property rights or otherwise. As a condition to exercising the
97+
rights and licenses granted hereunder, each Recipient hereby
98+
assumes sole responsibility to secure any other intellectual
99+
property rights needed, if any. For example, if a third party
100+
patent license is required to allow Recipient to Distribute the
101+
Program, it is Recipient's responsibility to acquire that license
102+
before distributing the Program.
103+
104+
d) Each Contributor represents that to its knowledge it has
105+
sufficient copyright rights in its Contribution, if any, to grant
106+
the copyright license set forth in this Agreement.
107+
108+
e) Notwithstanding the terms of any Secondary License, no
109+
Contributor makes additional grants to any Recipient (other than
110+
those set forth in this Agreement) as a result of such Recipient's
111+
receipt of the Program under the terms of a Secondary License
112+
(if permitted under the terms of Section 3).
113+
114+
3. REQUIREMENTS
115+
116+
3.1 If a Contributor Distributes the Program in any form, then:
117+
118+
a) the Program must also be made available as Source Code, in
119+
accordance with section 3.2, and the Contributor must accompany
120+
the Program with a statement that the Source Code for the Program
121+
is available under this Agreement, and informs Recipients how to
122+
obtain it in a reasonable manner on or through a medium customarily
123+
used for software exchange; and
124+
125+
b) the Contributor may Distribute the Program under a license
126+
different than this Agreement, provided that such license:
127+
i) effectively disclaims on behalf of all other Contributors all
128+
warranties and conditions, express and implied, including
129+
warranties or conditions of title and non-infringement, and
130+
implied warranties or conditions of merchantability and fitness
131+
for a particular purpose;
132+
133+
ii) effectively excludes on behalf of all other Contributors all
134+
liability for damages, including direct, indirect, special,
135+
incidental and consequential damages, such as lost profits;
136+
137+
iii) does not attempt to limit or alter the recipients' rights
138+
in the Source Code under section 3.2; and
139+
140+
iv) requires any subsequent distribution of the Program by any
141+
party to be under a license that satisfies the requirements
142+
of this section 3.
143+
144+
3.2 When the Program is Distributed as Source Code:
145+
146+
a) it must be made available under this Agreement, or if the
147+
Program (i) is combined with other material in a separate file or
148+
files made available under a Secondary License, and (ii) the initial
149+
Contributor attached to the Source Code the notice described in
150+
Exhibit A of this Agreement, then the Program may be made available
151+
under the terms of such Secondary Licenses, and
152+
153+
b) a copy of this Agreement must be included with each copy of
154+
the Program.
155+
156+
3.3 Contributors may not remove or alter any copyright, patent,
157+
trademark, attribution notices, disclaimers of warranty, or limitations
158+
of liability ("notices") contained within the Program from any copy of
159+
the Program which they Distribute, provided that Contributors may add
160+
their own appropriate notices.
161+
162+
4. COMMERCIAL DISTRIBUTION
163+
164+
Commercial distributors of software may accept certain responsibilities
165+
with respect to end users, business partners and the like. While this
166+
license is intended to facilitate the commercial use of the Program,
167+
the Contributor who includes the Program in a commercial product
168+
offering should do so in a manner which does not create potential
169+
liability for other Contributors. Therefore, if a Contributor includes
170+
the Program in a commercial product offering, such Contributor
171+
("Commercial Contributor") hereby agrees to defend and indemnify every
172+
other Contributor ("Indemnified Contributor") against any losses,
173+
damages and costs (collectively "Losses") arising from claims, lawsuits
174+
and other legal actions brought by a third party against the Indemnified
175+
Contributor to the extent caused by the acts or omissions of such
176+
Commercial Contributor in connection with its distribution of the Program
177+
in a commercial product offering. The obligations in this section do not
178+
apply to any claims or Losses relating to any actual or alleged
179+
intellectual property infringement. In order to qualify, an Indemnified
180+
Contributor must: a) promptly notify the Commercial Contributor in
181+
writing of such claim, and b) allow the Commercial Contributor to control,
182+
and cooperate with the Commercial Contributor in, the defense and any
183+
related settlement negotiations. The Indemnified Contributor may
184+
participate in any such claim at its own expense.
185+
186+
For example, a Contributor might include the Program in a commercial
187+
product offering, Product X. That Contributor is then a Commercial
188+
Contributor. If that Commercial Contributor then makes performance
189+
claims, or offers warranties related to Product X, those performance
190+
claims and warranties are such Commercial Contributor's responsibility
191+
alone. Under this section, the Commercial Contributor would have to
192+
defend claims against the other Contributors related to those performance
193+
claims and warranties, and if a court requires any other Contributor to
194+
pay any damages as a result, the Commercial Contributor must pay
195+
those damages.
196+
197+
5. NO WARRANTY
198+
199+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
200+
PERMITTED BY APPLICABLE LAW, THE PROGRAM IS PROVIDED ON AN "AS IS"
201+
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
202+
IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF
203+
TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
204+
PURPOSE. Each Recipient is solely responsible for determining the
205+
appropriateness of using and distributing the Program and assumes all
206+
risks associated with its exercise of rights under this Agreement,
207+
including but not limited to the risks and costs of program errors,
208+
compliance with applicable laws, damage to or loss of data, programs
209+
or equipment, and unavailability or interruption of operations.
210+
211+
6. DISCLAIMER OF LIABILITY
212+
213+
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, AND TO THE EXTENT
214+
PERMITTED BY APPLICABLE LAW, NEITHER RECIPIENT NOR ANY CONTRIBUTORS
215+
SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
216+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST
217+
PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
218+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
219+
ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE
220+
EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
221+
POSSIBILITY OF SUCH DAMAGES.
222+
223+
7. GENERAL
224+
225+
If any provision of this Agreement is invalid or unenforceable under
226+
applicable law, it shall not affect the validity or enforceability of
227+
the remainder of the terms of this Agreement, and without further
228+
action by the parties hereto, such provision shall be reformed to the
229+
minimum extent necessary to make such provision valid and enforceable.
230+
231+
If Recipient institutes patent litigation against any entity
232+
(including a cross-claim or counterclaim in a lawsuit) alleging that the
233+
Program itself (excluding combinations of the Program with other software
234+
or hardware) infringes such Recipient's patent(s), then such Recipient's
235+
rights granted under Section 2(b) shall terminate as of the date such
236+
litigation is filed.
237+
238+
All Recipient's rights under this Agreement shall terminate if it
239+
fails to comply with any of the material terms or conditions of this
240+
Agreement and does not cure such failure in a reasonable period of
241+
time after becoming aware of such noncompliance. If all Recipient's
242+
rights under this Agreement terminate, Recipient agrees to cease use
243+
and distribution of the Program as soon as reasonably practicable.
244+
However, Recipient's obligations under this Agreement and any licenses
245+
granted by Recipient relating to the Program shall continue and survive.
246+
247+
Everyone is permitted to copy and distribute copies of this Agreement,
248+
but in order to avoid inconsistency the Agreement is copyrighted and
249+
may only be modified in the following manner. The Agreement Steward
250+
reserves the right to publish new versions (including revisions) of
251+
this Agreement from time to time. No one other than the Agreement
252+
Steward has the right to modify this Agreement. The Eclipse Foundation
253+
is the initial Agreement Steward. The Eclipse Foundation may assign the
254+
responsibility to serve as the Agreement Steward to a suitable separate
255+
entity. Each new version of the Agreement will be given a distinguishing
256+
version number. The Program (including Contributions) may always be
257+
Distributed subject to the version of the Agreement under which it was
258+
received. In addition, after a new version of the Agreement is published,
259+
Contributor may elect to Distribute the Program (including its
260+
Contributions) under the new version.
261+
262+
Except as expressly stated in Sections 2(a) and 2(b) above, Recipient
263+
receives no rights or licenses to the intellectual property of any
264+
Contributor under this Agreement, whether expressly, by implication,
265+
estoppel or otherwise. All rights in the Program not expressly granted
266+
under this Agreement are reserved. Nothing in this Agreement is intended
267+
to be enforceable by any entity that is not a Contributor or Recipient.
268+
No third-party beneficiary rights are created under this Agreement.
269+
270+
Exhibit A - Form of Secondary Licenses Notice
271+
272+
"This Source Code may also be made available under the following
273+
Secondary Licenses when the conditions for such availability set forth
274+
in the Eclipse Public License, v. 2.0 are satisfied: {name license(s),
275+
version(s), and exceptions or additional permissions here}."
276+
277+
Simply including a copy of this Agreement, including this Exhibit A
278+
is not sufficient to license the Source Code under Secondary Licenses.
279+
280+
If it is not possible or desirable to put the notice in a particular
281+
file, then You may include the notice in a location (such as a LICENSE
282+
file in a relevant directory) where a recipient would be likely to
283+
look for such a notice.
284+
285+
You may add additional accurate notices of copyright ownership.

‎README.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Arduino Pro IDE
2+
The Arduino IDE for advanced users and developers.
3+
4+
## Idea
5+
The new Arduino IDE is a completely new Development Environment for Arduino Programming based on more modern technologies.
6+
This repo is a preview of the final product and has to be considered as an unstable *alpha* version.
7+
8+
## Download
9+
You can find the last published version in the [Releases Section](https://github.com/arduino/arduino-pro-ide/releases) of this repo
10+
11+
## User Feedback and Issue Report
12+
We need your help in improving the product, before releasing the source code we want to move out of the alpha and we need your help.
13+
Please test the Arduino Pro IDE and report us bugs or feature requests at: https://github.com/arduino/arduino-pro-ide/issues
14+
15+
## Technology
16+
The Arduino Pro IDE is based on the following technologies:
17+
18+
* [Arduino CLI](https://github.com/arduino/arduino-cli)
19+
Used in daemon mode is providing all the main Arduino features
20+
* [Eclipse Theia](https://github.com/eclipse-theia/theia)
21+
The frontend of the application is based on this [Open Source IDE](https://theia-ide.org/)
22+
* [Electron](https://github.com/electron/electron)
23+
The framework behind [Eclipse Theia](https://theia-ide.org/), allows to use web technologies on desktop environments
24+
25+
If you want to know more about the people involved please look at the [Contribution list](CONTRIBUTIONS.md)

0 commit comments

Comments
 (0)