Skip to content

Commit

Permalink
Merge pull request #134 from abejgonzalez/docs
Browse files Browse the repository at this point in the history
Added readthedocs documentation
  • Loading branch information
abejgonzalez committed Dec 8, 2018
2 parents 3b15a2b + eee781e commit a061fd5
Show file tree
Hide file tree
Showing 80 changed files with 3,590 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ External Debug |√

**Google group:** (https://groups.google.com/forum/#!forum/riscv-boom)

For documentation on BOOM visit the BOOM website (www.boom-core.org/).
For documentation and publications on BOOM visit the BOOM website (www.boom-core.org/).


### Important!
Expand Down Expand Up @@ -160,7 +160,9 @@ For more details (and to download o3-pipeview.py), visit the [gem5 wiki](http://

## More Info

* **The Design Spec** - https://github.com/riscv-boom/riscv-boom-doc
Check out the BOOM website @ https://boom-core.org!

* **The Design Spec** - https://docs.boom-core.org
* **Google group:** - https://groups.google.com/forum/#!forum/riscv-boom
* **Chisel Learning Journey** - https://github.com/librecores/riscv-sodor/wiki/Chisel-Learning-Journey
* **Tech Report** - The Berkeley Out-of-Order Machine (BOOM): An Industry-Competitive, Synthesizable, Parameterized RISC-V Processor (https://www.eecs.berkeley.edu/Pubs/TechRpts/2015/EECS-2015-167.html)
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
19 changes: 19 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0 comments on commit a061fd5

Please sign in to comment.