rust-pitaya/README.md

49 lines
1.3 KiB
Markdown
Raw Normal View History

2020-10-14 15:56:10 +08:00
Rust Pitaya
===========
Minimalist bare metal Rust firmware for Red Pitaya.
Development instructions
------------------------
Pure build with Nix and execution on a remote JTAG server:
```shell
2022-08-29 22:14:58 +08:00
nix build .#rust-pitaya-jtag
2020-10-14 15:56:10 +08:00
./remote_run.sh
```
Impure incremental build and execution on a remote JTAG server:
```shell
2022-08-29 22:14:58 +08:00
nix develop
2020-10-14 15:56:10 +08:00
cd src
gateware/rust-pitaya.py -g ../build/gateware # build gateware
make # build firmware
cd ..
./remote_run.sh -i
```
Notes:
- The impure build process is also compatible with non-Nix systems.
- If the board is connected to the local machine, use the ``local_run.sh`` script.
License
-------
2022-08-29 22:14:58 +08:00
Copyright (C) 2019-2022 M-Labs Limited.
2020-10-14 15:56:10 +08:00
Rust Pitaya is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Rust Pitaya is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with Rust Pitaya. If not, see <http://www.gnu.org/licenses/>.