Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Update readme with minimal zicond details #9

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 20 additions & 34 deletions readme.adoc
Original file line number Diff line number Diff line change
@@ -1,53 +1,39 @@
= RISC-V docs-spec-template
# RISC-V Conditional operation instructions

This repository is used to prime GitHub repos for the RISC-V organization which will be used
to create specifications.
*RISC-V conditional operation extension standardisation work.*

**If you are reading this in a specification repo, please update the title for this section and
provide your introduction to your repository.**
- [About](##About)
- [Specification](##Specification)
- [Contributors](##Contributors)
- [Dependencies](##Dependencies)

= License
## About

This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0).
See the link:LICENSE[LICENSE] file for details.
This repository is used to develop standardisation proposals conditional operation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to be rephrased

instruction set extension for the RISC-V architecture.

= Contributors
## Specification

To see the latest draft release of the proposals, look at the
[Releases](https://github.com/riscv/riscv-zicond/releases) tab of
the [Github Repository](https://github.com/riscv/riscv-zicond).


## Contributors

Contributors to this specification are contained in the link:contributors.adoc[contributors] file.

For instructions on how to contribute please see the link:CONTRIBUTING.md[CONTRIBUTING] file.

= Dependencies
## Dependencies

This project is built using AsciiDoctor (Ruby). The repository has been setup to build the PDF on
checkin using GitHub actions. Workflow dependencies are located in the `dependencies` directory.

For more information on AsciiDoctor, specification guidelines, or building locally, see the
https://github.com/riscv/docs-dev-guide[RISC-V Documentation Developer Guide].

= Cloning the project

This project uses https://git-scm.com/book/en/v2/Git-Tools-Submodules[GitHub Submodules]
to include the https://github.com/riscv/docs-resources[RISC-V docs-resources project]
to achieve a common look and feel.

When cloning this repository for the first time, you must either use
`git clone --recurse-submodules` or execute `git submodule init` and `git submodule update` after the clone to populate the docs-resources directory. Failure to clone the submodule, will result
in the PDF build fail with an error message like the following:

$ make
asciidoctor-pdf \
-a toc \
-a compress \
-a pdf-style=docs-resources/themes/riscv-pdf.yml \
-a pdf-fontsdir=docs-resources/fonts \
--failure-level=ERROR \
-o profiles.pdf profiles.adoc
asciidoctor: ERROR: could not locate or load the built-in pdf theme `docs-resources/themes/riscv-pdf.yml'; reverting to default theme
No such file or directory - notoserif-regular-subset.ttf not found in docs-resources/fonts
Use --trace for backtrace
make: *** [Makefile:7: profiles.pdf] Error 1

= Building the document

## Building the document

The final specification form of PDF can be generated using the `make` command.