Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
StaticRocket committed Jan 6, 2019
1 parent e227ab0 commit 7623de1
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Did you not like the look of the Arduino IDE but were stuck with it nevertheless
## Troubleshooting
* The verify/build output does not appear? Make sure your Arduino official IDE language is set to English.
* Windows
* Getting `Uncaught Error: spawn EPERM`? Be sure you don't have the Microsoft Store version of the Arduino IDE. - [#65](https://github.com/Sorunome/arduino-upload/issues/65)
* Can't install because of the serialport package? Try installing the [Visual C++ 2015 building tools](https://github.com/felixrieseberg/windows-build-tools) by running `.\npm install --global --production windows-build-tools` from the directory `%LocalAppData%\atom\app-[VERSION]\resources\app\apm\bin` in an adminastrative PowerShell (this uses atoms integrated npm instead of requiring an external instance). Then update apm config with `apm config set msvs_version [VERSION]` (the version installed by the tool should be 2015) and `apm config set python [PATH]\python.exe` (where PATH is the path to the python executable). - [#46](https://github.com/Sorunome/arduino-upload/issues/46)
* Getting `Uncaught Error: spawn EPERM`? Be sure you don't have the Microsoft Store version of the Arduino IDE. - [#65](https://github.com/Sorunome/arduino-upload/issues/65)
* Can't install because of the serialport package? Try installing the [Visual C++ 2015 building tools](https://github.com/felixrieseberg/windows-build-tools) by running `.\npm install --global --production windows-build-tools` from the directory `%LocalAppData%\atom\app-[VERSION]\resources\app\apm\bin` in an adminastrative PowerShell (this uses atoms integrated npm instead of requiring an external instance). Then update apm config with `apm config set msvs_version [VERSION]` (the version installed by the tool should be 2015) and `apm config set python [PATH]\python.exe` (where PATH is the path to the python executable). - [#46](https://github.com/Sorunome/arduino-upload/issues/46)


## Available commands
Expand All @@ -27,11 +27,13 @@ Did you not like the look of the Arduino IDE but were stuck with it nevertheless
* `arduino-upload:upload` - Uploads the current sketch to a connected arduino
* `arduino-upload:serial-monitor` - Opens the serial monitor of a connected arduino

You can place these commands in a toolbar using the [**Flex Tool Bar**](https://atom.io/packages/flex-tool-bar) package. [Here's how](docs/toolbar.md).
You can place these commands in a toolbar using the [**Flex Tool Bar**](https://atom.io/packages/flex-tool-bar) package. [Here's how](https://github.com/Sorunome/arduino-upload/blob/master/docs/toolbar.md).

## Screenshots
Verifying a program:
![verify](docs/screenshots/verify.gif)

![verify](https://raw.githubusercontent.com/Sorunome/arduino-upload/master/docs/screenshots/verify.gif)

Serial monitor:
![serial](docs/screenshots/serial.gif)

![serial](https://raw.githubusercontent.com/Sorunome/arduino-upload/master/docs/screenshots/serial.gif)

0 comments on commit 7623de1

Please sign in to comment.