From 2c4b1dae652df0256ed6cf194e68b63e050c8351 Mon Sep 17 00:00:00 2001 From: Abraham Gonzalez Date: Thu, 4 Nov 2021 22:33:52 -0700 Subject: [PATCH] Use Chipyard top-level README | Add README Quick Links + Update resources [ci skip] --- .github/{README.md => README} | 0 README.md | 14 +++++++++++--- 2 files changed, 11 insertions(+), 3 deletions(-) rename .github/{README.md => README} (100%) diff --git a/.github/README.md b/.github/README similarity index 100% rename from .github/README.md rename to .github/README diff --git a/README.md b/README.md index d231a73c..fe8f54a7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ ![CHIPYARD](https://github.com/ucb-bar/chipyard/raw/master/docs/_static/images/chipyard-logo-full.png) # Chipyard Framework [![Test](https://github.com/ucb-bar/chipyard/workflows/chipyard-ci-process/badge.svg?style=svg)](https://github.com/ucb-bar/chipyard/actions) + +## Quick Links + +* **DOCUMENTATION**: https://chipyard.readthedocs.io/ +* **USER QUESTION FORUM**: https://groups.google.com/forum/#!forum/chipyard +* **BUGS AND FEATURE-REQUESTS**: https://github.com/ucb-bar/chipyard/issues + ## Using Chipyard To get started using Chipyard, see the documentation on the Chipyard documentation site: https://chipyard.readthedocs.io/ @@ -16,13 +23,14 @@ Chipyard is actively developed in the [Berkeley Architecture Research Group][ucb ## Resources * Chipyard Documentation: https://chipyard.readthedocs.io/ -* Chipyard Basics slides: https://fires.im/micro19-slides-pdf/02_chipyard_basics.pdf -* Chipyard Tutorial Exercise slides: https://fires.im/micro19-slides-pdf/03_building_custom_socs.pdf +* Chipyard (x FireSim) Tutorial: https://fires.im/tutorial +* Chipyard Basics slides: https://fires.im/micro21-slides-pdf/02_chipyard_basics.pdf +* Chipyard Tutorial Exercise slides: https://fires.im/micro21-slides-pdf/03_building_custom_socs.pdf ## Need help? * Join the Chipyard Mailing List: https://groups.google.com/forum/#!forum/chipyard -* If you find a bug, post an issue on this repo +* If you find a bug or would like propose a feature, post an issue on this repo: https://github.com/ucb-bar/chipyard/issues ## Contributing