Skip to content

Commit ecba53d

Browse files
authored
Merge pull request #56 from Neotron-Compute/update-docs
Update README.md
2 parents 9d450df + f925b90 commit ecba53d

File tree

1 file changed

+48
-14
lines changed

1 file changed

+48
-14
lines changed

README.md

Lines changed: 48 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,24 @@ This OS is a work in progress. We intend to support:
1010
* [x] Calling BIOS APIs
1111
* [x] Text mode VGA console
1212
* [x] Serial console
13-
* [ ] Starting a command-line shell application
14-
* [ ] Executing applications from RAM
15-
* [ ] MBR/FAT32 formatted block devices with standard open/close/read/write file semantics
13+
* [x] Running built-in commands from a shell
14+
* [x] Executing applications from RAM
15+
* [x] Applications can print to stdout
16+
* [ ] Applications can read from stdin
17+
* [ ] Applications can open/close/read/write files
18+
* [x] MBR/FAT32 formatted block devices
19+
* [x] Read blocks
20+
* [x] Directory listing of /
21+
* [ ] Write to files
22+
* [ ] Delete files
23+
* [ ] Change directory
24+
* [x] Load ELF binaries from disk
25+
* [ ] Changing text modes
1626
* [ ] Basic networking
1727
* [ ] Music playback
1828
* [ ] Various keyboard layouts
1929
* [ ] Ethernet / WiFi networking
30+
* [ ] Built-in scripting language
2031

2132
## Build instructions
2233

@@ -55,20 +66,43 @@ See [`CHANGELOG.md`](./CHANGELOG.md)
5566

5667
## Licence
5768

58-
Neotron-OS Copyright (c) The Neotron Developers, 2022
69+
```text
70+
Neotron-OS Copyright (c) Jonathan 'theJPster' Pallant and The Neotron Developers, 2023
5971
60-
This program is free software: you can redistribute it and/or modify
61-
it under the terms of the GNU General Public License as published by
62-
the Free Software Foundation, either version 3 of the License, or
63-
(at your option) any later version.
72+
This program is free software: you can redistribute it and/or modify
73+
it under the terms of the GNU General Public License as published by
74+
the Free Software Foundation, either version 3 of the License, or
75+
(at your option) any later version.
6476
65-
This program is distributed in the hope that it will be useful,
66-
but WITHOUT ANY WARRANTY; without even the implied warranty of
67-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
68-
GNU General Public License for more details.
77+
This program is distributed in the hope that it will be useful,
78+
but WITHOUT ANY WARRANTY; without even the implied warranty of
79+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
80+
GNU General Public License for more details.
6981
70-
You should have received a copy of the GNU General Public License
71-
along with this program. If not, see <https://www.gnu.org/licenses/>.
82+
You should have received a copy of the GNU General Public License
83+
along with this program. If not, see <https://www.gnu.org/licenses/>.
84+
```
85+
86+
See the full text in [LICENSE.txt](./LICENSE.txt). Broadly, we (the developers)
87+
interpret this to mean (and note that we are not lawyers and this is not
88+
legal advice) that if you give someone a Neotron computer, you must also give them
89+
one of:
90+
91+
* Complete and corresponding source code (e.g. on disk, or as a link to your
92+
**own** on-line Git repo) for any GPL components (e.g. the BIOS and the OS),
93+
as supplied on the Neotron computer.
94+
* A written offer to provide complete and corresponding source code on
95+
request.
96+
97+
If you are not offering a Neotron computer commercially (i.e. you are not
98+
selling a board for commercial gain), and you are using an unmodified upstream
99+
version of the source code, then the third option is to give them:
100+
101+
* A link to the tag/commit-hash on the relevant official Neotron Github
102+
repository - <https://github.com/Neotron-Compute/Neotron-OS>.
103+
104+
This is to ensure everyone always has the freedom to access the source code in
105+
their Neotron based computer.
72106

73107
## Contribution
74108

0 commit comments

Comments
 (0)