Skip to content

Update doc for MacOS and Windows #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update doc for MacOS and Windows #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0cc381
Update doc for MacOS and Windows
manchoz Oct 31, 2022
71592f3
Apply suggestions from code review
manchoz Nov 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ It generates a README.md file that contains information regarding libraries and
In order to run this tool you have to install first the [Arduino CLI](https://github.com/arduino/arduino-cli) and have `arduino-cli` binary in your `$PATH`, otherwise `arduino-cslt` won't work.
Please use a version of the Arduino CLI that has [this](https://github.com/arduino/arduino-cli/pull/1608) change (version > 0.20.2).

Another requirement is [`gcc-ar`](https://sourceware.org/binutils/docs/binutils/ar.html) (installable with `apt-get install gcc`) in your `$PATH`.
Another requirement is [`gcc-ar`](https://sourceware.org/binutils/docs/binutils/ar.html) in your `$PATH`.

- On Linux `gcc-ar` can be obtained by installing GCC (e.g., `apt-get install gcc`).
- On macOS `gcc-ar` can be obtained by installing `binutils` (e.g. `brew install binutils`) and creating a symlink from `gar` to `gcc-ar` (`ln -s /usr/local/Cellar/binutils/2.39_1/bin/gar /usr/local/bin/gcc-ar`).
- On Windows `gcc-ar` can be obtained by installing `binutils` (e.g. `scoop install binutils`).

## Build it
In order to build `arduino-cslt` just use `task go:build`
Expand Down Expand Up @@ -115,4 +119,4 @@ Library libsketch has been declared precompiled:
Using precompiled library in sketch-dist/libsketch/src/cortex-m0plus
Sketch uses 14636 bytes (5%) of program storage space. Maximum is 262144 bytes.
Global variables use 3224 bytes (9%) of dynamic memory, leaving 29544 bytes for local variables. Maximum is 32768 bytes.
```
```