Skip to content

Commit da04b5f

Browse files
update readme with building section
1 parent 824c8ec commit da04b5f

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,29 @@ Its userland is completely written in a dialect of BASIC based heavily on BBC BA
4646

4747
## 🔨 Documentation
4848

49-
You can learn all about the project via the [official website at http://retrorocket.dev](http://retrorocket.dev) where we document technical details, provide a user guide, and BASIC reference.
49+
You can learn all about the project via the [official website at http://retrorocket.dev](http://retrorocket.dev) where we document technical details, provide a user guide, and BASIC reference.
50+
51+
## Building
52+
53+
You should not need to build Retro Rocket yourself. Under the releases, and the actions for the project, you will find ready-built
54+
ISO and USB images you can burn straight to media. If you do want to build it yourself, you will need the following build dependencies:
55+
56+
- gcc-14 or higher
57+
- cmake
58+
- make
59+
- nasm
60+
- xorriso
61+
- mtools
62+
- php 8.4 or higher
63+
64+
To build, make a build directory, e.g. `build`, and then run `cmake` referencing the source directory:
65+
66+
```
67+
cd retrorocket
68+
mkdir build
69+
cd build
70+
cmake ..
71+
make -j $NPROC
72+
```
73+
74+
the ISO and USB images will be written to the build directory.

0 commit comments

Comments
 (0)