Skip to content

Commit

Permalink
Add directory structure description to readme
Browse files Browse the repository at this point in the history
related to #26

other minor edits:

* minor wording changes
* add line spacing between blocks
* add `shell` to code blocks

Signed-off-by: Kevin Broch <[email protected]>
  • Loading branch information
kbroch-rivosinc committed Jan 23, 2024
1 parent 5728161 commit 3e4767b
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions readme.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= RISC-V Specification Template

This repository serves as a blueprint for creating GitHub repositories within the RISC-V organization for the purpose of developing specifications. The template aims to facilitate and standardize the process of specification development.
This repository serves as a template for creating GitHub repositories within the RISC-V organization for the purpose of developing specifications. It aims to facilitate and standardize the process of specification development.

NOTE: If you are viewing this in a specification repository, kindly update the title for this section and provide an introduction relevant to your repository.

Expand All @@ -16,26 +16,38 @@ For guidelines on how to contribute, refer to the link:CONTRIBUTING.md[CONTRIBUT

== 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
* asciiDoctor-pdf, asciidoctor-bibtex, asciidoctor-diagram, and asciidoctor-mathematical
* Docker

=== Cloning the Repository
```

```shell
git clone --recurse-submodules https://github.com/riscv/docs-spec-template.git
```

=== Building the Documentation

To start the build process, run:
```

```shell
cd ./docs-spec-template && make build
```

The Makefile script will check the availability of Docker on your system:
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.
Expand All @@ -47,7 +59,7 @@ The build process utilizes several options, including theming and font settings,
=== Cleaning up

To clean up the generated files, run:
```

```shell
make clean
```
This will remove the generated PDF file.

0 comments on commit 3e4767b

Please sign in to comment.