You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+33-25Lines changed: 33 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,9 +51,14 @@ This repository contains:
51
51
52
52
== Prerequisites
53
53
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.
55
56
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:
57
62
58
63
* For Apptainer, see https://apptainer.org/docs/admin/main/installation.html[Apptainer Installation].
59
64
* 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:
62
67
You do *not* need root privileges to download or use the container. However, to modify/build the container,
63
68
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.
64
69
65
-
== Setup
70
+
When you run with Singularity/Apptainer, the files under `bin/`
# 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.
76
81
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
79
85
80
-
=== VSCode
86
+
To run the devcontainer locally, you will need to have https://docs.docker.com/engine/install[Docker installed].
81
87
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.
84
89
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.
0 commit comments