Broccoli/broccoli-cli
3
0
Fork 1
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update README.

Browse Source
This commit is contained in:
jpt4 2023-05-17 17:14:27 +00:00
parent 983aa99c16
commit 4248e9fd99
1 changed files with 22 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,8 +1,21 @@
# Broccoli Development Environment # Broccoli Development Environment
First time use:
Download the Skywater 130nm PDK and Configuration Files:
https://broccoli-hosting.s3.us-east-2.amazonaws.com/sky130.tar.gz
Extract to your home directory:
```
mkdir ~/tech; tar -xzvf sky130.tar.gz -C ~/tech
```
First and subsequent use:
Pull the docker image for the broccoli command line interface. Pull the docker image for the broccoli command line interface.
``` ```
docker pull git.broccolimicro.io/broccoli/broccoli-cli:latest docker pull public.ecr.aws/l5h5o6z4/broccoli-cli:latest
``` ```
Setup the broccoli command line interface with the following command. Setup the broccoli command line interface with the following command.
@ -10,12 +23,6 @@ Setup the broccoli command line interface with the following command.
source bcli-develop.sh source bcli-develop.sh
``` ```
Set up your ssh connection to the technology node server, it is preferrable to set up an ssh key.
```
export BROCCOLI_USER="nbingham"
bcli mount
```
Download the developement environment and boot it up in docker Download the developement environment and boot it up in docker
``` ```
bcli up bcli up
@ -26,6 +33,11 @@ Open up a shell inside the development environment. Here you will have access to
bcli bcli
``` ```
If graphical tools (such as magic and gaw) fail to launch, you may need to install ```xhost``` on your local machine, and grant docker permission to access your X server.
```
xhost +local:docker
```
Your home directory will be mounted at Your home directory will be mounted at
``` ```
/host /host
@ -36,13 +48,13 @@ Many of the installed tools may be found at
/opt /opt
``` ```
Finally, vim is fully set up for both golang and act Finally, vim is fully set up for both golang and act.
``` ```
vim file.act vim file.act
``` ```
When you are done, you can shut down the development environment and disconnect the technology server. When you are done, you can shut down the development environment.
``` ```
bcli down bcli down
bcli unmount
``` ```