Skip to content

Commit 7a2d4da

Browse files
crawfxrdjackpot51
crawfxrd
authored and
jackpot51
committed
docs: Move info from README to docs/
Signed-off-by: Tim Crawford <tcrawford@system76.com>
1 parent cab3891 commit 7a2d4da

File tree

8 files changed

+65
-61
lines changed

8 files changed

+65
-61
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Changes are identified by the date of the released firmware including them. If
44
you are running System76 Open Firmware, opening the boot menu will show this
55
date followed by an underscore and a short git revision. To see if specific
66
features apply to your model and firmware version, see the
7-
[feature matrix](./FEATURES.md).
7+
[feature matrix](./docs/features.md).
88

99
## unreleased
1010

‎LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The license for the embedded controller firmware depends on the binary used.
3333

3434
#### Intel binaries
3535

36-
Intel provides biniaries under a redistributable license, which may be
36+
Intel provides binaries under a redistributable license, which may be
3737
different per binary.
3838

3939
- `me.rom`: Intel CSME

‎README.md

Lines changed: 6 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -3,59 +3,10 @@
33
An open source distribution of firmware utilizing coreboot, EDK2, and System76
44
firmware applications.
55

6-
## Supported models and features
6+
## Resources
77

8-
To view models that are supported and will receive updates through the firmware
9-
manager, as well as available features for those models, please see the
10-
[feature matrix](./FEATURES.md).
11-
12-
Other models may be in development or available without support, and can be
13-
seen in the `models/` directory.
14-
15-
If the device becomes bricked it will require restoring the current firmware
16-
using an external programmer. See [flashing](./docs/flashing.md) for details.
17-
18-
### Schematics
19-
20-
System76 customers may request board schematics for their system by sending an
21-
email to firmware@system76.com with the subject line "Schematics for _model_",
22-
where _model_ is one of the supported models listed above. Please include the
23-
serial number of your system for verification.
24-
25-
You may not share these without explicit permission from System76.
26-
27-
## Changelog
28-
29-
For a list of important changes please see the [changelog](./CHANGELOG.md).
30-
31-
## Building
32-
33-
Dependencies can be installed with the provided script.
34-
35-
```sh
36-
./scripts/install-deps.sh
37-
```
38-
39-
If rustup was installed for the first time, it will be required to source the
40-
environment file it installed to use the correct Rust toolchain.
41-
42-
```
43-
source ~/.cargo/env
44-
```
45-
46-
A script is provided to build the firmware. The available targets for building
47-
are the model folders in `models/`. For example, to build for QEMU:
48-
49-
```
50-
./scripts/build.sh qemu
51-
```
52-
53-
Once built, the firmware must be flashed to use. Several scripts are available
54-
to flash the new firmware, depending on how it is going to be written.
55-
56-
- `scripts/qemu.sh`: [Run the firmware in QEMU](./docs/debugging.md#using-qemu) (specific to the QEMU model)
57-
- `scripts/flash.sh`: Flash using the internal flasher
58-
- `scripts/ch341a-flash.sh`: Flash using a CH341A programmer
59-
- `scripts/spipi-flash.sh`: Flash using a Raspberry Pi
60-
61-
See [Flashing firmware](./docs/flashing.md) for more details.
8+
- [Project site](https://github.com/system76/firmware-open)
9+
- [Documentation](./docs/index.md)
10+
- [Issue tracker](https://github.com/system76/firmware-open/issues/)
11+
- [Changelog](./CHANGELOG.md)
12+
- [Legal information](./LICENSE.md)

‎docs/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
- [Index](./index.md)
44
- [Firmware features](./features.md)
5+
- [Building firmware](./building.md)
56
- [Flashing firmware](./flashing.md)
67
- [Debugging](./debugging.md)
78
- [Adding a new board](./adding-a-new-board.md)
89
- [Intel CSME](./intel-me.md)
910
- [UEFI](./uefi.md)
11+
- [Schematics](./schematics.md)

‎docs/building.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Building
2+
3+
Dependencies can be installed with the provided script.
4+
5+
```
6+
./scripts/install-deps.sh
7+
```
8+
9+
If rustup was installed for the first time, it will be required to source the
10+
environment file it installed to use the correct Rust toolchain.
11+
12+
```
13+
. ~/.cargo/env
14+
```
15+
16+
A script is provided to build the firmware. The available targets for building
17+
are the model folders in `models/`. For example, to build for QEMU:
18+
19+
```
20+
./scripts/build.sh qemu
21+
```
22+
23+
Once built, the firmware must be flashed to use. Several scripts are available
24+
to flash the new firmware, depending on how it is going to be written.
25+
26+
- `scripts/qemu.sh`: [Run the firmware in QEMU](./debugging.md#using-qemu) (specific to the QEMU model)
27+
- `scripts/flash.sh`: Flash using firmware-update
28+
- `scripts/ch341a-flash.sh`: Flash using a CH341A programmer
29+
- `scripts/spipi-flash.sh`: Flash using a Raspberry Pi
30+
31+
See [Flashing firmware](./flashing.md) for more details.

‎FEATURES.md renamed to ‎docs/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This lists important features provided by System76 Open Firmware. Your system
44
must be updated to at least the firmware version specified in the following
55
[platform tables](#platforms) to include all specified [features](#features).
66
To see the changes in specific firmware versions, see the
7-
[changelog](./CHANGELOG.md).
7+
[changelog](./../CHANGELOG.md).
88

99
## Platforms
1010

‎docs/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
# Documentation
22

33
This is the documentation for System76 Open Firmware. It is set up to be used
4-
with [mdBook], which can generate HTML output for easy navigation.
4+
with [mdBook](https://github.com/rust-lang/mdBook), which can generate HTML
5+
output for easy navigation.
56

6-
7-
[mdBook]: https://github.com/rust-lang/mdBook
7+
```
8+
mdbook build --open docs/
9+
```

‎docs/schematics.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Schematics
2+
3+
## Systems using System76 Open Firmware
4+
5+
System76 customers may request board schematics for their system by sending an
6+
email to `firmware@system76.com` with the subject line:
7+
8+
> Schematics for &lt;model&gt;
9+
10+
where `<model>` is a model that uses firmware-open. Include the serial number
11+
of your system for verification.
12+
13+
You may not share these without explicit permission from System76.
14+
15+
## Other models and components
16+
17+
System76 cannot provide schematics for models not using firmware-open, nor
18+
datasheets for any components that are not already publicly available.

0 commit comments

Comments
 (0)