summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIan Moffett <ian@osmora.org>2025-11-15 16:08:11 -0500
committerIan Moffett <ian@osmora.org>2025-11-15 16:11:14 -0500
commit713293c04e91535c8780ab85cc4a2b5d688975a7 (patch)
treea8dd3f060375e664db40c05ba2e616c65e938fee /README.md
parente7c6d41ed56d36591019eb2d939b1de52692c1a8 (diff)
docs: Add build instructions
Signed-off-by: Ian Moffett <ian@osmora.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1a68ac0..148a3e6 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,27 @@
# RV7 - preparing since 2025
-*Work is being done, we are glad your eyes earn a delight*
+*Work is being done, we are glad your eyes earn a delight.*
+
+## Build Instructions for the RV7 Enjoying OSMORIANs
+
+> [!IMPORTANT]
+> It is important that you have the correct dependencies installed before you attempt
+> to build the system, see dependencies section.
+
+First you must bootstrap the project by running ``./boostrap``. The project can then
+be configured by running ``./configure``.
+
+Before the system can be built, you must build yourself a toolchain by running
+``make toolchain``, this will take awhile but once it is complete the system can be built
+with a single ``make``.
+
+## Dependencies
+
+The following is required to be installed to build the system:
+
+- xorriso
+- make
+- git
+- autoconf
+- clang
+- as