Skip to content

Commit 85a3735

Browse files
committed
Update README.
Add better Windows instructions.
1 parent 2b074c7 commit 85a3735

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
# Shared libraries from OS build
99
*.dylib
1010
*.so
11+
*.dll
1112

1213
# Our uncompressed disk image
1314
disk.img

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@ Build and run this BIOS (and use it to boot Neotron OS) with...
2828
```console
2929
~ $ git checkout https://github.com/neotron-compute/Neotron-Desktop-BIOS.git
3030
~ $ cd Neotron-Desktop-BIOS
31-
~/Neotron-Desktop-BIOS $ RUST_LOG=debug cargo run -- --config=./nvram.dat --os=./libneotron_os.so
31+
~/Neotron-Desktop-BIOS $ RUST_LOG=debug cargo run -- --nvram=./nvram.dat --os=./libneotron_os.so
3232
```
3333

34-
Press `Esc` with the GUI window selected to quit the BIOS.
34+
In the OS run the `shutdown` command to quit.
3535

3636
The file `libneotron_os.so` is not supplied. You can build it with:
3737

@@ -61,20 +61,38 @@ The file `libneotron_os.so` is not supplied. You can build it with:
6161
C:\Users\user\Documents> set LIB=%LIB%;C:\Users\user\Documents\vcpkg\installed\x64-windows\lib
6262
```
6363

64+
4. Build as usual:
65+
66+
```console
67+
C:\Users\user\Documents\neotron-desktop-bios> cargo run --release -- --nvram=.\nvram.dat --os=.\neotron_os.dll
68+
```
69+
70+
In the OS run the `shutdown` command to quit.
71+
72+
The file `neotron_os.dll` is not supplied. You can build it with:
73+
74+
```console
75+
C:\Users\user\Documents> git checkout https://github.com/neotron-compute/neotron-os.git
76+
C:\Users\user\Documents> cd neotron-os
77+
C:\Users\user\Documents\neotron-os> cargo build --release --lib
78+
C:\Users\user\Documents\neotron-os> copy .\target\release\neotron_os.dll ..\Neotron-Desktop-BIOS
79+
```
80+
6481
## Features
6582

6683
* GUI window with pixel-perfect video rendering
6784
* Block device support
6885
* Keyboard support
6986
* Power-off support
87+
* Config file support
7088
* TODO: Audio support
7189
* TODO: UART support
7290

7391
## Changelog
7492

7593
### Unreleased Changes ([Source](https://github.com/neotron-compute/Neotron-Desktop-BIOS/tree/main))
7694

77-
* None
95+
* Added config get/set
7896

7997
### v0.1.0 ([Source](https://github.com/neotron-compute/Neotron-Desktop-BIOS/tree/v0.1.0))
8098

0 commit comments

Comments
 (0)