This repository has been archived by the owner on Mar 21, 2024. It is now read-only.
generated from riscv/docs-spec-template
-
Notifications
You must be signed in to change notification settings - Fork 7
Update readme with minimal zicond details #9
Open
nibrunieAtSi5
wants to merge
2
commits into
riscvarchive:main
Choose a base branch
from
nibrunieAtSi5:patch-2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 |
---|---|---|
@@ -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 | ||
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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