generated from riscv/docs-spec-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Derek Hower <[email protected]>
- Loading branch information
Derek Hower
committed
Mar 21, 2024
1 parent
4137e0f
commit 14adb99
Showing
10 changed files
with
3 additions
and
295 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* Derek Hower (Qualcomm) |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +1,17 @@ | ||
= RISC-V Combined Instructions SIG | ||
= RISC-V Scalar Efficiency SIG | ||
|
||
== License | ||
|
||
This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0). For details, see the link:LICENSE[LICENSE] file. | ||
|
||
== Contributors | ||
|
||
The list of contributors to this specification is maintained in the link:src/contributors.adoc[contributors] file. | ||
The list of contributors to this specification is maintained in the link:contributors.adoc[contributors] file. | ||
|
||
For guidelines on how to contribute, refer to the link:CONTRIBUTING.md[CONTRIBUTING] file. | ||
|
||
== Building the Document | ||
|
||
=== Directory Structure | ||
|
||
The following directories are used to organize the contents of this repo: | ||
|
||
* `dependencies/`: software dependencies needed to build the specification | ||
* `docs-resources/`: resources for all specifications sourced from link:.gitmodules[git submodule] | ||
* `src/`: source files for the specification | ||
* `build/`: default directory where the build artifacts are generated | ||
|
||
=== Prerequisites | ||
|
||
To build the document, you'll need the following tools installed on your system: | ||
|
||
* Make | ||
* asciiDoctor-pdf, asciidoctor-bibtex, asciidoctor-diagram, and asciidoctor-mathematical | ||
* Docker | ||
|
||
=== Cloning the Repository | ||
|
||
```shell | ||
git clone --recurse-submodules https://github.com/riscv-admin/riscv-combined-instructions.git | ||
``` | ||
|
||
=== Building the Documentation | ||
|
||
To start the build process, run: | ||
|
||
```shell | ||
cd ./riscv-combined-instructions && make build | ||
``` | ||
|
||
The link:Makefile[] script will check the availability of Docker on your system: | ||
|
||
* If Docker is available, the documentation will be built inside a Docker container using the image riscvintl/riscv-docs-base-container-image:latest. This ensures a consistent build environment across different systems. | ||
* If Docker is not available, the documentation will be built directly on your system using the installed tools. | ||
|
||
The documentation is generated from the AsciiDoctor source files in your project. The primary source file is specified by the `HEADER_SOURCE` variable in the Makefile. | ||
|
||
The build process utilizes several options, including theming and font settings, and generates a PDF document as output. | ||
|
||
=== Cleaning up | ||
|
||
To clean up the generated files, run: | ||
|
||
```shell | ||
make clean | ||
``` |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.