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

Commit

Permalink
Docs (#92)
Browse files Browse the repository at this point in the history
* General docs about the project

* 'Added contribution mentioning'

* Added copyright info

* Fixed typos and Copyright notice

* Added minimal getting started section

* Fix wording
  • Loading branch information
mastrolinux authored and Roberto Sora committed Oct 23, 2019
1 parent 2247b19 commit 1725ae0
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,34 @@
# Arduino Pro IDE
The new Arduino Pro IDE bring features that address the needs of advanced users whilst retaining continuity with the simple "classic" Arduino IDE.
The Arduino Pro IDE bring features that address the needs of advanced users whilst retaining continuity with the simple "classic" Arduino IDE.

*This repo is an a preview of the final product and has to be considered as an unstable *alpha* version.*

## Idea
The new Arduino Pro IDE is a completely new Development Environment for Arduino Programming based on more modern technologies.
The Arduino Pro IDE is a completely new Development Environment for Arduino Programming based on more modern technologies.

## Getting Started

### Download

You can download this alpha preview for testing and feedback from the [Releases Section](https://github.com/arduino/arduino-pro-ide/releases) of this repo. *Note this is not a production release!*

### Arduino CLI

The Arduino Pro IDE uses the `arduino-cli` binary found in the system's PATH or its own embedded one if the `arduino-cli` is not found.
So please be sure you have the latest version of the CLI as described in the [How to Install the Arduino CLI](https://github.com/arduino/arduino-cli#how-to-install) doc,
or remove your `arduino-cli` from the system PATH

You can check your `arduino-cli` version with

```
$ arduino-cli version
```

### Install a core to support your board
The Arduino Pro IDE does not provide pre-installed cores, to have board support you have to install a core by using the menu

Tools -> Board Manager...

Then search for your board and install the appropriate core.

## User Feedback and Issue Report
Before releasing the source code we want to move out of the alpha and we want your feedback to do this! Please test the Arduino Pro IDE and report bugs or feature requests at: https://github.com/arduino/arduino-pro-ide/issues

Expand Down

0 comments on commit 1725ae0

Please sign in to comment.