Skip to content

Commit ab53983

Browse files
authored
Merge pull request #18 from 0x6e3078/feature/fix_readme_for_mac
Fixing README.md for mac users and the git clone
2 parents 06451aa + c0ab5d9 commit ab53983

File tree

1 file changed

+40
-14
lines changed

1 file changed

+40
-14
lines changed

README.md

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,12 @@ This is the [Neotron](https://github.com/neotron-compute) BIOS that lets you run
1010

1111
This BIOS uses [pix-engine](https://crates.io/crates/pix-engine), so should run on any platform that pix-engine supports.
1212

13-
If you have a Mac, run:
14-
15-
```console
16-
brew install sdl2
17-
brew install sdl2_mixer
18-
brew install sdl2_image
19-
export LIBRARY_PATH="$LIBRARY_PATH:$(brew --prefix)/lib"
20-
```
21-
22-
You will need to re-run the `export` command before you re-build the application.
23-
2413
## Building on Linux
2514

2615
Build and run this BIOS (and use it to boot Neotron OS) with...
2716

2817
```console
29-
~ $ git checkout https://github.com/neotron-compute/Neotron-Desktop-BIOS.git
18+
~ $ git clone https://github.com/Neotron-Compute/Neotron-Desktop-BIOS.git
3019
~ $ cd Neotron-Desktop-BIOS
3120
~/Neotron-Desktop-BIOS $ gunzip -c disk.img.gz > disk.img
3221
~/Neotron-Desktop-BIOS $ RUST_LOG=debug cargo run -- --nvram=./nvram.dat --os=./libneotron_os.so --disk=./disk.img
@@ -37,14 +26,51 @@ In the OS run the `shutdown` command to quit.
3726
The file `libneotron_os.so` is not supplied. You can build it with:
3827

3928
```console
40-
~ $ git checkout https://github.com/neotron-compute/neotron-os.git
29+
~ $ git clone https://github.com/neotron-compute/neotron-os.git
4130
~ $ cd neotron-os
4231
~/neotron-os $ cargo build --release --lib
4332
~/neotron-os $ ls ./target/release/*.so
4433
./target/release/libneotron_os.so
4534
~/neotron-os $ cp ./target/release/libneotron_os.so ~/Neotron-Desktop-BIOS
4635
```
4736

37+
## Building on MacOS
38+
39+
Install dependencies first:
40+
41+
```console
42+
brew install sdl2
43+
brew install sdl2_ttf
44+
brew install sdl2_gfx
45+
brew install sdl2_mixer
46+
brew install sdl2_image
47+
export LIBRARY_PATH="$LIBRARY_PATH:$(brew --prefix)/lib"
48+
```
49+
50+
You will need to re-run the `export` command before you re-build the application.
51+
52+
53+
The file `libneotron_os.dylib` is not supplied. Build it first with:
54+
55+
```console
56+
~ $ mkdir Neotron
57+
~ $ cd Neotron
58+
~/Neotron $ git clone https://github.com/neotron-compute/neotron-os.git
59+
~/Neotron $ cd neotron-os
60+
~/Neotron/neotron-os $ cargo build --release --lib
61+
~/Neotron/neotron-os $ ls ./target/release/*.so
62+
./target/release/libneotron_os.dylib
63+
```
64+
65+
```console
66+
~ $ cd ~/Neotron
67+
~/Neotron $ git clone https://github.com/Neotron-Compute/Neotron-Desktop-BIOS.git
68+
~/Neotron $ cd Neotron-Desktop-BIOS
69+
~/Neotron/Neotron-Desktop-BIOS $ gunzip -c disk.img.gz > disk.img
70+
~/Neotron/Neotron-Desktop-BIOS $ cp ~/Neotron/neotron-os/target/release/libneotron_os.dylib ./
71+
~/Neotron/Neotron-Desktop-BIOS $ RUST_LOG=debug cargo run -- --nvram=./nvram.dat --os=./libneotron_os.dylib --disk=./disk.img
72+
```
73+
4874
## Building on Windows
4975

5076
1. Install and bootstrap [vcpkg](https://github.com/microsoft/vcpkg)
@@ -75,7 +101,7 @@ The file `libneotron_os.so` is not supplied. You can build it with:
75101
The file `neotron_os.dll` is not supplied. You can build it with:
76102

77103
```console
78-
C:\Users\user\Documents> git checkout https://github.com/neotron-compute/neotron-os.git
104+
C:\Users\user\Documents> git clone https://github.com/neotron-compute/neotron-os.git
79105
C:\Users\user\Documents> cd neotron-os
80106
C:\Users\user\Documents\neotron-os> cargo build --release --lib
81107
C:\Users\user\Documents\neotron-os> copy .\target\release\neotron_os.dll ..\Neotron-Desktop-BIOS

0 commit comments

Comments
 (0)