33 Commits

Author SHA1 Message Date
per1234
e8b0ea4f2d Reduce overlap between readme and development+contributor guides
The readme should provide a concise overview of the essential information about the project. Additional details are
provided in dedicated documents, so the readme only needs to provide links to that information.
2022-09-15 05:53:09 -07:00
per1234
d07d83fdfe Move development documentation to a more suitable location
Previously, information about project development was stored in a file named BUILDING.md in the root of the repository.

That content is hereby moved to the file docs/development.md. This will provide the following benefits:

- Broaden the scope of the file to all information related to development rather than building only
- Store all documentation content under a single folder instead of randomly putting some in the root and others under
  docs
2022-09-15 05:53:09 -07:00
Alberto Iannaccone
6e3fe08c4c update README.md 2022-09-13 23:58:23 -07:00
per1234
59ca91d805 Remove table of nightly build links from readme
During the early phase of development, the download links for the nightly build were only available from the table in the project readme.

Since that time, download links were also added to the "Software" page on arduino.cc, which is already linked to from
the readme. This means the nightly build link table is superfluous and only harms the readability of the readme.

The superfluous table is hereby removed from the readme.
2022-09-12 06:04:36 -07:00
per1234
c9996df11c Add Linux AppImage to nightly build download links
Linux x86-64 builds of the Arduino IDE are now available in AppImage format in additional to the ZIP format.

Since only the AppImage format IDE supports auto-updates (the IDE installed from the ZIP will notify of available updates, but can't auto-update), this will be the preferred format and so good beta testing coverage of it is especially important.
2022-03-07 03:30:31 -08:00
Silvano Cerza
cc5764e536 Update README.md
Co-authored-by: per1234 <accounts@perglass.com>
2021-12-14 17:47:31 +01:00
Silvano Cerza
9131f2d09e Update README.md with translations project link 2021-12-14 17:47:31 +01:00
per1234
ac502053d7 Add security policy link to readme 2021-03-09 00:20:39 -08:00
per1234
1d8eb0d544 Update ARM Linux links in download tables
The issue numbers changed when they were transferred from the arduino/arduino-pro-ide to arduino/arduino-ide repositories.
2021-03-08 23:51:04 -08:00
Alessandro Ranellucci
22e02e19b8
Update README before making the repository public (#49)
* Update README

* Some more changes to README

* Add anchor to link to Arduino Software Download page Section for IDE 2.0

Co-authored-by: Roberto Sora <r.sora@arduino.cc>
2021-03-01 15:59:23 +01:00
Akos Kitta
ec1abcc989 Fixed the build status badge in the main README.
Closes arduino/arduino-ide#7

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2021-02-12 13:06:11 +01:00
Akos Kitta
b3deb2fd34 Aligned workflow/docs with the default branch name
This is required after switching the default from `master` to `main`.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2021-02-11 15:12:23 +01:00
Akos Kitta
b8647f16ad Renamed the application. Updated links and version
Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2021-02-11 09:59:46 +01:00
Akos Kitta
00a3ee34c8 Added a script to update the versions.
Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2020-12-14 15:33:06 +01:00
per1234
6535c70686 Add signed MSI package to the "Arduino Pro IDE" workflow 2020-10-20 14:19:04 -07:00
per1234
7068b9b1d3 Add signed Windows installer package to the "Arduino Pro IDE" workflow
The previous "zip" Windows package is retained, but an installer is also produced.
2020-10-20 14:19:04 -07:00
Akos Kitta
960d8dba2e removed that uses a more recent version of the CLI from the PATH
from now on, we always use the one from the IDE. Documented how to replace it on demand.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2020-08-19 10:50:51 +02:00
Akos Kitta
0942ef6450 Switched from grpc to @grpc/grpc-js.
This change is required to be able to support ARM arch
in the future.

 - Fixed the download links for armv7l Linux.
 - Checked in the generated code. [grpc/grpc-node#1497]
 - Made the code generation a manual step.
 - Made the `grpc-tools` dependency optional.
 - From now on, the serial port regex is case-insensitive.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2020-07-13 13:30:06 +02:00
Akos Kitta
976f858c7c Documented basic architecture overview.
Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2020-07-09 16:10:31 +02:00
Akos Kitta
2f93af4faa Fixed the build-badge in the README.
- Added the missing link to GH Actions.
 - Fixed  a typo.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2020-07-09 09:17:15 +02:00
Akos Kitta
45f06718b4 Updated the documentation.
- [macOS] Removed `zip` target. We need it later for the auto-update.
 - [CI]: From now on, the release tag must not start with `v`.
 - [yarn]: Added steps on how to rebuild the natives from the source.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2020-07-08 14:21:06 +02:00
Jan Keromnes
41c56c1126 [doc] Document Arduino Pro IDE extension and a few services 2019-12-06 16:03:58 +00:00
Jan Keromnes
3f180b6059
[minor] Make the README.md GIFs a bit smaller 2019-12-06 11:07:03 +01:00
Jan Keromnes
6a8a76f720
[minor] Fix project name in README.md 2019-12-06 11:04:01 +01:00
Akos Kitta
90d7d88162 Updated the application name, version to 0.0.2.
Increased the heap size for the packager.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2019-10-25 11:48:33 +02:00
Akos Kitta
6d590cd111 Fixed the packager for the new folder structure.
Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2019-09-02 14:57:28 +02:00
Akos Kitta
cd94608aee Renamed the applications.
Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2019-08-29 08:05:47 +02:00
Akos Kitta
0aa34b1169
Added the Prerequisites section to the README.
Closes #44.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2019-07-26 11:25:40 +02:00
Akos Kitta
93daed6a69 Updated with the application download link.
Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2019-05-09 11:02:56 +02:00
Akos Kitta
507fbd0fd1 Updated the README with the build step.
From now on, Electron `4.x` is used for the dev.
Otherwise, we could not use `@grpc/grpc-js`.

Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2019-05-09 09:11:18 +02:00
Akos Kitta
bb9435b125 Updated the README.
Signed-off-by: Akos Kitta <kittaakos@typefox.io>
2019-05-08 22:31:09 +02:00
Christian Weichel
ba995e6869 Upaded readme 2019-05-08 20:10:56 +02:00
Christian Weichel
201351fea8 Moving repo to bmci-labs 2019-05-06 10:25:29 +02:00