Skip to content

Commit

Permalink
New directory strusture, documentation streamlined
Browse files Browse the repository at this point in the history
  • Loading branch information
remuslazar committed Jan 11, 2020
1 parent dfe5152 commit ea687da
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@ This repository holds the documentation and software needed to build a Slack int
Project Folder Structure
---

* `src/**` Sourcecode
* `src/arduino/**` Arduino firmware (c++)
* `firmware/**` Firmware for the Arduino MKR1010 WiFi Board (C++)
* `doc/*` Documentation Files (Markdown)


Expand Down
21 changes: 11 additions & 10 deletions doc/Setup.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
Setup Dev Environment
====

Arduino IDE
--

Install [Arduino IDE](https://www.arduino.cc/en/Main/Software).
### PlatformIO and related

Install also the [arduino-cli](https://github.com/arduino/arduino-cli):
This project uses [PlatformIO Core](https://platformio.org/install/cli) for development. The [setup process](https://docs.platformio.org/en/latest/installation.html) (on a Mac) is straightforward:

```bash
brew update
brew install arduino-cli
pip install -U --user platformio
```

#### Setup Arduino Dev Environment
Make sure you do already have the Python 2.7 bin dir (`$HOME/Library/Python/2.7/bin`) in `$PATH`.

`cd src/arduino` and then run `make setup`.
Development and Upload
----

This will install the samd Arduino Core and the required libraries (when not already installed).
CLion IDE is being used for development. The device firmware is in the `firmware/` folder. To e.g. upload a new firmware via USB, do:

```bash
cd firmware
run --target upload --upload-port /dev/cu.usbmodem14701
```

Clion IDE
--
Expand Down

0 comments on commit ea687da

Please sign in to comment.