Skip to content

Commit

Permalink
Remove unused files
Browse files Browse the repository at this point in the history
Signed-off-by: Derek Hower <dhower@qti.qualcomm.com>
  • Loading branch information
Derek Hower committed Mar 21, 2024
1 parent 4137e0f commit 14adb99
Show file tree
Hide file tree
Showing 10 changed files with 3 additions and 295 deletions.
71 changes: 0 additions & 71 deletions Makefile

This file was deleted.

1 change: 1 addition & 0 deletions contributors.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* Derek Hower (Qualcomm)
36 changes: 0 additions & 36 deletions example.bib

This file was deleted.

48 changes: 2 additions & 46 deletions readme.adoc
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
```
4 changes: 0 additions & 4 deletions src/bibliography.adoc

This file was deleted.

47 changes: 0 additions & 47 deletions src/chapter2.adoc

This file was deleted.

7 changes: 0 additions & 7 deletions src/contributors.adoc

This file was deleted.

67 changes: 0 additions & 67 deletions src/header.adoc

This file was deleted.

2 changes: 0 additions & 2 deletions src/index.adoc

This file was deleted.

15 changes: 0 additions & 15 deletions src/intro.adoc

This file was deleted.

0 comments on commit 14adb99

Please sign in to comment.