Minor but important Doc updates More written instructions to come in the next patches of doc updates.
diff --git a/Makefile b/Makefile index 7a1745d..e0a9e5c 100644 --- a/Makefile +++ b/Makefile
@@ -6,15 +6,14 @@ ARCHIVES := $(shell find . -type f -name "*.gz") ARCHIVE_SOURCES := $(basename $(ARCHIVES)) -ifndef PDK_ROOT -$(error PDK_ROOT is undefined, please export it before running make) -endif .DEFAULT_GOAL := ship - # We need portable GDS_FILE pointers... .PHONY: ship ship: uncompress + ifndef PDK_ROOT + $(error PDK_ROOT is undefined, please export it before running make) + endif @echo "###############################################" @echo "Generating Caravel GDS (sources are in the 'gds' directory)" @sleep 1
diff --git a/README.md b/README.md index 447fe6a..cffca22 100644 --- a/README.md +++ b/README.md
@@ -6,6 +6,20 @@ <img src="/doc/ciic_harness.png" width="75%" height="75%"> </p> +## Getting Started: + +Start by cloning the repo and uncompressing the files. +```bash +git clone https://github.com/efabless/caravel.git +cd caravel +make uncompress +``` + +Then, you can learn more about the caravel chip by watching these video: +- Caravel User Project Features -- https://youtu.be/zJhnmilXGPo +- Aboard Caravel -- How to put your design on Caravel? -- https://youtu.be/9QV8SDelURk +- Things to Clarify About Caravel -- What versions to use with Caravel? -- https://youtu.be/-LZ522mxXMw + ## Managment SoC The managment SoC runs firmware that can be used to: - Configure Mega Project I/O pads