@@ -6,6 +6,7 @@ This is the Neotron OS. It will run on any system which can execute ARM Thumb v7
66
77This OS is a work in progress. We intend to support:
88
9+ * [x] Calling BIOS APIs
910* [ ] Text mode console (on both text and bitmap displays)
1011* [ ] Starting a command-line shell application
1112* [ ] Executing applications from RAM
@@ -14,3 +15,44 @@ This OS is a work in progress. We intend to support:
1415* [ ] Music playback
1516* [ ] Various keyboard layouts
1617
18+ ## Build Instructions
19+
20+ ```
21+ $ git clone https://github.com/neotron-compute/Neotron-OS.git
22+ $ cd Neotron-OS
23+ $ git submodule update --init
24+ $ nano ./Cargo.toml # Edit to use appropriate linker script
25+ $ cargo build --release
26+ $ cargo run --release # Fires up GDB to flash the board
27+ ```
28+
29+ ## Changelog
30+
31+ ### Unreleased Changes ([ Source] ( https://github.com/neotron-compute/Neotron-OS/tree/master ) )
32+
33+ * Basic UART hello on start-up
34+
35+ ## Licence
36+
37+ Neotron-OS Copyright (c) The Neotron Developers, 2020
38+
39+ This program is free software: you can redistribute it and/or modify
40+ it under the terms of the GNU General Public License as published by
41+ the Free Software Foundation, either version 3 of the License, or
42+ (at your option) any later version.
43+
44+ This program is distributed in the hope that it will be useful,
45+ but WITHOUT ANY WARRANTY; without even the implied warranty of
46+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
47+ GNU General Public License for more details.
48+
49+ You should have received a copy of the GNU General Public License
50+ along with this program. If not, see <https://www.gnu.org/licenses/>.
51+
52+ ## Contribution
53+
54+ Unless you explicitly state otherwise, any contribution intentionally
55+ submitted for inclusion in the work by you shall be licensed as above, without
56+ any additional terms or conditions.
57+
58+
0 commit comments