|
1 | | -# Neotron-XXX-BIOS |
| 1 | +# Neotron Desktop BIOS |
2 | 2 |
|
3 | | -> Template repository for new BIOS implementations. You should delete these |
4 | | -> quoted blocks and correct the rest of the text as required. |
| 3 | +This is the [Neotron](https://github.com/neotron-compute) BIOS that lets you run the Neotron OS as a Linux, macOS or Windows application! |
5 | 4 |
|
6 | | -This is the [Neotron](https://github.com/neotron-compute) BIOS for the FooBar XYZ development board. |
| 5 | + |
7 | 6 |
|
8 | | - |
9 | | - |
10 | | - |
| 7 | + |
11 | 8 |
|
12 | 9 | ## Compatibility |
13 | 10 |
|
14 | | -This BIOS will run on the official FooBar XYZ Developer Kit, and also the FooBar XYZ Explorer board. Both feature the same FooBar XYZ SoC. Other boards with the same SoC can be supported with a minor change to the pin configurations. |
15 | | - |
16 | | -## Features |
| 11 | +This BIOS uses [pix-engine](https://crates.io/crates/pix-engine), so should run on any platform that pix-engine supports. |
17 | 12 |
|
18 | | -> Replace this with the specs of your board! |
| 13 | +## Building |
19 | 14 |
|
20 | | -The FooBar XYZ Developer Kit offers: |
| 15 | +Build and run this BIOS (and use it to boot Neotron OS) with... |
21 | 16 |
|
22 | | -* 128 KiB RAM |
23 | | -* 512 KiB Flash |
24 | | -* Cortex-M4 clocked at 64 MHz |
25 | | -* SD/MMC Slot, with DMA |
26 | | -* 3-wire TTL UART |
27 | | -* Hardware accelerated graphics blitter |
28 | | -* 8-colour VGA output on pins P0, P1, P2, P4 and P5. |
29 | | -* Stereo sound on the on-board 3.5mm jack |
| 17 | +```console |
| 18 | +~ $ git checkout https://github.com/neotron-compute/Neotron-Desktop-BIOS.git |
| 19 | +~ $ cd Neotron-Desktop-BIOS |
| 20 | +~/Neotron-Desktop-BIOS $ RUST_LOG=debug cargo run -- --serial=/dev/ttyS0 --peripheral=sdmmc,./disk.img --os=./libneotron_os.so |
| 21 | +``` |
30 | 22 |
|
31 | | -The FooBar XYZ Explorer Board adds: |
| 23 | +Press `Esc` with the GUI window selected to quit the BIOS. |
32 | 24 |
|
33 | | -* On-board LCD with 480x272 resolution (60x17 text mode) in 16 colours |
34 | | -* RS-232 port |
35 | | - |
36 | | -## Changelog |
| 25 | +The file `libneotron_os.so` is not supplied. You can build it with: |
37 | 26 |
|
38 | | -> Your repo should implement a Changelog in this format. Add a new section |
39 | | -> every time you tag a release. Don't forget to change `$GITHUB_USERNAME` and |
40 | | -> `$GITHUB_REPO` to the appropriate values for your repository! |
| 27 | +```console |
| 28 | +~ $ git checkout https://github.com/neotron-compute/neotron-os.git |
| 29 | +~ $ cd neotron-os |
| 30 | +~/neotron-os $ cargo build --release --lib |
| 31 | +~/neotron-os $ ls ./target/release/*.so |
| 32 | +./target/release/libneotron_os.so |
| 33 | +~/neotron-os $ cp ./target/release/libneotron_os.so ~/Neotron-Desktop-BIOS |
| 34 | +``` |
41 | 35 |
|
42 | | -### Unreleased Changes ([Source](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/tree/master) | [Changes](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/compare/v0.2.0...master)) |
43 | | - |
44 | | -* None |
| 36 | +## Features |
45 | 37 |
|
46 | | -### v0.2.0 ([Source](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/tree/v0.2.0) | [Changes](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/compare/v0.1.0...v0.2.0)) |
| 38 | +* GUI window with pixel-perfect video rendering |
| 39 | +* TODO: UART support |
| 40 | +* TODO: SD/MMC emulation support |
| 41 | +* TODO: Audio support |
| 42 | +* TODO: Human Interface Device support |
47 | 43 |
|
48 | | -* Fixed changelog in README. |
| 44 | +## Changelog |
49 | 45 |
|
50 | | -### v0.1.0 ([Source](https://github.com/$GITHUB_USERNAME/$GITHUB_REPO/tree/v0.1.0)) |
| 46 | +### Unreleased Changes ([Source](https://github.com/neotron-compute/Neotron-Desktop-BIOS/tree/main)) |
51 | 47 |
|
52 | 48 | * First release |
53 | 49 |
|
54 | 50 | ## Licence |
55 | 51 |
|
56 | | -> This is an example licence. You can change it if you so desire, but please |
57 | | -> do pay attention to the licenses of any components you use in your BIOS. |
58 | | -
|
59 | | - Neotron-XXX-BIOS Copyright (c) Some Developer, 2019 |
| 52 | + Neotron-Desktop-BIOS Copyright (c) Jonathan 'theJPster' Pallant, 2022 |
60 | 53 |
|
61 | 54 | This program is free software: you can redistribute it and/or modify |
62 | 55 | it under the terms of the GNU General Public License as published by |
|
0 commit comments