Skip to content

Commit 2c42d86

Browse files
author
Derek Hower
committed
Update README.adoc
1 parent dc211a8 commit 2c42d86

File tree

1 file changed

+33
-25
lines changed

1 file changed

+33
-25
lines changed

README.adoc

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,14 @@ This repository contains:
5151

5252
== Prerequisites
5353

54-
The only requirement is the `Singularity CE` (>= 3.3) or `Apptainer` (>= 1.0) container system. Either one will work (they are forks).
54+
There are two supported ways to run the RISC-V Unified Database,
55+
both of which are container-based.
5556

56-
If it is not installed, either as your IT admin or:
57+
=== Singularity/Apptainer
58+
59+
You can run within `Singularity CE` (>= 3.3) or `Apptainer` (>= 1.0) container system. Either one will work (they are forks).
60+
61+
If it is not installed, either ask your IT admin or:
5762

5863
* For Apptainer, see https://apptainer.org/docs/admin/main/installation.html[Apptainer Installation].
5964
* For Singularity CE, see https://docs.sylabs.io/guides/latest/admin-guide/installation.html[Singularity CE Installation].
@@ -62,35 +67,31 @@ If it is not installed, either as your IT admin or:
6267
You do *not* need root privileges to download or use the container. However, to modify/build the container,
6368
you will need either root privileges or the ability to run in `fakeroot` mode. See https://docs.sylabs.io/guides/4.1/user-guide/fakeroot.html[Singularity Fakeroot Documentation] for more information.
6469

65-
== Setup
70+
When you run with Singularity/Apptainer, the files under `bin/`
71+
will run within the container, _e.g._:
6672

67-
Do once:
73+
```bash
74+
./bin/ruby --version
75+
# => ruby 3.2.3 (2024-01-18 revision 52bb2ac0a6) [x86_64-linux-gnu]
76+
```
6877

69-
[source,bash]
70-
----
71-
./bin/setup
78+
=== Devcontainer
7279

73-
# or, if you also want development tools (:development group in Gemfile) installed
74-
# DEVELOPMENT=1 ./bin/setup
75-
----
80+
You can also leverage https://containers.dev/[devcontainers] to run the RISC-V Unified Database.
7681

77-
[NOTE]
78-
If you forget, don't worry. Setup will be invoked by any program in bin/ if necessary.
82+
This is especially useful when using Visual Studio Code or GitHub codespaces, as it will setup up your IDE environment for you.
83+
84+
==== VS Code
7985

80-
=== VSCode
86+
To run the devcontainer locally, you will need to have https://docs.docker.com/engine/install[Docker installed].
8187

82-
If using Visual Studio Code and want to use development tools, you will need to restart the editor
83-
after setup.
88+
With Docker installed, install the https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers[Dev Containers] extension in VS Code.
8489

85-
Helpful extensions are
90+
You can then run `Dev Containers: Open Folder in Container...` from the Command Palette (Ctrl+Shift+P) and select the folder with this repository.
8691

87-
* https://marketplace.visualstudio.com/items?itemName=asciidoctor.asciidoctor-vscode[AsciiDoc]
88-
* https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml[YAML]
89-
* https://marketplace.visualstudio.com/items?itemName=castwide.solargraph[Solargraph] (for a Ruby Language Server)
90-
* https://marketplace.visualstudio.com/items?itemName=onnovalkering.vscode-singularity[Singularity] (if you plan on working on the container)
92+
==== GitHub Codespaces
9193

92-
The `.vscode/settings.json` file in the repo will ensure that Solargraph works without any additional
93-
configuration (assuming you've already run ./bin/setup).
94+
You can start a GitHub Codespace for this repository by clicking the "Code" button and selecting "Open with Codespaces".
9495

9596
== Tasks
9697

@@ -100,9 +101,16 @@ Quick start:
100101
----
101102
./do --tasks # list all documented tasks
102103
103-
# examples
104-
./do validate # validate against the schema
105-
./do gen:arch[generic_rv64] # generate arch spec for the 'generic_rv64' config
104+
## examples
105+
106+
# validate against the schema
107+
./do validate
108+
109+
# generate all versions of ISA manual, as an Antora static website
110+
./do gen:html_manual MANUAL_NAME=isa VERSIONS=all
111+
112+
# generate an implementation-specific spec for the 'generic_rv64' config
113+
./do gen:arch[generic_rv64]
106114
----
107115

108116
== More info

0 commit comments

Comments
 (0)