Skip to content

Commit 367cc6a

Browse files
committed
docs: add install instructions
1 parent 3abea22 commit 367cc6a

1 file changed

Lines changed: 31 additions & 7 deletions

File tree

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ $ sudo bythos
8282
8383
luks:
8484
ok TPM binding TPM2 token on 1 device
85-
ok boot chain binding PCRs: 4 7 9; firmware and full boot chain measured
85+
ok boot chain binding PCRs: 4 7 9; boot chain measured
8686
8787
platform firmware:
8888
ok Intel BIOS write protection BLE and SMM_BWP set; BIOS region protected
@@ -95,21 +95,45 @@ $ sudo bythos
9595
ok HSI: Boot Guard enabled and verified
9696
```
9797

98-
## Quick Start
98+
## Install
99+
100+
Grab the latest build from
101+
[Releases](https://github.com/q1sh101/bythos/releases) and check it against
102+
`SHA256SUMS`. Any x86_64 Linux with glibc 2.34 or newer works: Debian 12+,
103+
Ubuntu 22.04+, Fedora, Arch.
104+
105+
```bash
106+
# debian / ubuntu
107+
sudo apt install ./bythos_0.1.0_amd64.deb
108+
109+
# any x86_64 linux
110+
tar -xzf bythos-v0.1.0-x86_64-linux.tar.gz
111+
cd bythos-v0.1.0-x86_64-linux
112+
sudo install -Dm 0755 bythos /usr/local/bin/bythos
113+
sudo install -Dm 0644 bythos.1 /usr/local/share/man/man1/bythos.1
114+
```
115+
116+
### From source
117+
118+
Needs a C11 compiler and GNU Make (`gcc make` on most distributions).
99119

100120
```bash
101121
git clone https://github.com/q1sh101/bythos
102122
cd bythos && make && sudo make install
123+
```
103124

125+
Install paths can be overridden with `prefix`, `bindir`, `mandir`, `DESTDIR`.
126+
Remove with `sudo make uninstall`.
127+
128+
## Quick Start
129+
130+
```bash
104131
sudo bythos # requires root for full coverage
105132
bythos --json # machine-readable output
106133
bythos --help
107134
bythos --version
108135
```
109136

110-
Install paths can be overridden with `prefix`, `bindir`, `mandir`, `DESTDIR`.
111-
Remove with `sudo make uninstall`.
112-
113137
## How It Works
114138

115139
**bythos opens no sockets, writes no files, runs no shell, and ignores `$PATH`.**
@@ -152,7 +176,7 @@ degrade their checks to `skip`, never `fail`.
152176
| `skip` | Not applicable or not observable on this run |
153177

154178
`skip` is not a hidden pass. It means bythos could not make that observation:
155-
hardware absent, helper missing, field absent, root required, vendor mismatch,
179+
hardware absent, helper missing, field absent, not configured, vendor mismatch,
156180
or output unparseable, among other typed reasons (full list in `man bythos`).
157181

158182
Plain output uses lowercase labels. `--json` capitalizes them (`OK`, `WARN`,
@@ -222,4 +246,4 @@ Human-written PRs only; LLM-generated submissions are not accepted.
222246

223247
Built for engineers who care about firmware trust.
224248

225-
**Built by** Giorgi Kishmareia · [q1sh101](https://github.com/q1sh101)
249+
**Built by** Giorgi Kishmareia

0 commit comments

Comments
 (0)