Skip to content

Commit

Permalink
update install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gundralaa committed Jul 16, 2023
1 parent 3e7b406 commit 772257e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/src/InstallLF.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ git checkout pico
Add the `lingua-franca/bin` directory to your `PATH` environment variable:

```
export PATH=.../lingua-franca/bin:${PATH}
export PATH=../lingua-franca/bin:${PATH}
```

where `...` is replaced by the path to the folder where you cloned the `lingua-franca` repository. For convenience, put the above command in your `~/.bash_profile` file so that the environment variable is available to any bash terminal.
Expand Down
22 changes: 10 additions & 12 deletions docs/src/InstallLFPico.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,21 @@ or
git clone https://github.com/lf-lang/lf-pico.git
```

Then:
## Setup
To create a reproducible unix shell environment that installs all required dependency applications, we use the nix package manager. Install [nix](https://nixos.org/download.html) first for your preferred platform. There is support for windows (wsl), macos and linux.

After installation, run the following in the shell to enable the experimental nix flakes feature.
``` bash
mkdir -p ~/.config/nix
echo "experimental-features = nix-command flakes" >> ~/.config/nix/nix.conf
```
cd lf-pico
git submodule update --init --recursive
```

## Setup Script

Assuming you are in the `lf-pico` root directory, run:

```
platform/pico_setup.sh
To launch the lf-pico shell environment, run the following in the root of the lf-pico repository.
```bash
nix develop
```

After running the setup script, a directory `pico` will contain the RPi-Pico dependencies and will build a few simple examples
for getting started. The script comes from this [source](https://github.com/michaelstoops/pico-setup/tree/master).
This should automatically download and install specific revisions of the gcc-arm toolchain, openocd and picotool. These packages will be required compiling, flashing and debugging C code for the RP2040.

(You can alternatively manually [install the Raspberry Pi Pico Tools](InstallingPicoTools.md).)

Expand Down

0 comments on commit 772257e

Please sign in to comment.