Skip to content

Commit 99323d6

Browse files
committed
doc: yowasp
1 parent 78a354e commit 99323d6

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

GetStarted_Yowasp.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Getting started with Silice using YoWASP (all platforms)
2+
3+
## Install
4+
5+
Silice is available as a [YoWASP](https://yowasp.org/) package. This is a great
6+
way to use Silice under any platform that supports python, as YoWASP runs
7+
WebAssembly compiled tools from python. Yes, this means no pain with compiling
8+
from tools or dealing with incompatible binaries!
9+
10+
To install Silice with YoWASP, simply run [get_started_yowasp.sh](get_started_yowasp.sh), assuming you already have a working installation
11+
of `python` and `pip`. This will install all required YoWASP package.
12+
13+
Then, head to a project, such as `projects/blinky` and run:
14+
15+
```make yowasp-<BOARD>```
16+
17+
where BOARD is the name of a [supported board](frameworks/board). For instance:
18+
19+
```make yowasp-icebreaker```.
20+
21+
22+
23+
## Sending the bitstream to your board
24+
25+
26+

get_started_yowasp.sh

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#!/bin/bash
2+
echo "--------------------------------------------------------------------"
3+
echo "This script installs all necessary python packages"
4+
echo "Requirements: python and pip"
5+
echo ""
6+
echo "You may run into the error externally-managed-environment, in which"
7+
echo "case you can create a venv for local package installation."
8+
echo " https://docs.python.org/3/library/venv.html "
9+
# e.g. https://stackoverflow.com/questions/75602063/pip-install-r-requirements-txt-is-failing-this-environment-is-externally-mana
10+
echo ""
11+
echo "Please refer to the script source code to see the list of packages"
12+
echo "--------------------------------------------------------------------"
13+
14+
read -p "Please type 'y' to go ahead, any other key to exit: " -n 1 -r
15+
if [[ ! $REPLY =~ ^[Yy]$ ]]
16+
then
17+
echo
18+
echo "Exiting."
19+
exit
20+
fi
21+
22+
pip install yowasp-yosys
23+
pip install yowasp-nextpnr-ice40
24+
pip install yowasp-nextpnr-ecp5
25+
pip install yowasp-silice
26+
pip install edalize

0 commit comments

Comments
 (0)