Skip to content

Commit

Permalink
Update readme.adoc
Browse files Browse the repository at this point in the history
Signed-off-by: Rafael Sene <rafael@riscv.org>
  • Loading branch information
rpsene authored Jun 29, 2023
1 parent 88ff3f9 commit 72fba36
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,26 @@ To build the document, you'll need the following tools installed on your system:

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

=== Versioning, Customization and Makefile Variables

This section provides an overview of the environment variables used in our Makefile. These variables include DATE, VERSION, and REVMARK.

* `DATE`: Represents the current date. The default value is generated using the date command on Unix-based systems, formatted as "YYYY-MM-DD".
* `VERSION`: Represents the version of the specification being built. By default, this is set to 'v0.0.0'. You can change this to a different value, like 'v1.0.0', 'v1.1.0', etc., based on the current version of your specification.
* `REVMARK`: This represents a revision marker for the project. Its default value is 'Draft'. You may want to change this to something like 'Release' or 'Stable'.
* `PDF_RESULT`: Specifies the name of the output PDF file.
* `DOCKER_RUN`: Defines the Docker run command used when Docker is available.

==== Setting Environment Variables

These variables can be overridden by setting environment variables on your system. Here's how you can do it in Linux and MacOS:

```bash
export VERSION=v1.2.3
export REVMARK=Release
export PDF_RESULT=spec.pdf
```

=== Building the Documentation

To start the build process, run `cd ./docs-spec-template && make build`.
Expand All @@ -44,16 +64,3 @@ The build process utilizes several options, including theming and font settings,
=== Cleaning up

To clean up the generated files, run `make clean`. This will remove the generated PDF file.

== Versioning

The `VERSION` variable is used to specify the revision number for the generated documentation. The default revision number is "v0.0.0".

== Customization

You can customize the build process by modifying the following variables in the Makefile:

* `DATE`: Specifies the revision date for the generated documentation. The default value is the current date.
* `REVMARK`: Specifies the revision remark for the generated documentation. The default value is "Draft".
* `PDF_RESULT`: Specifies the name of the output PDF file.
* `DOCKER_RUN`: Defines the Docker run command used when Docker is available.

0 comments on commit 72fba36

Please sign in to comment.