68 Commits

Author SHA1 Message Date
Vicente Reyes cdc7a46162 Small grammar change 2025-12-03 09:56:25 -08:00
Markus Unterwaditzer a46ede37b6 Fix links in README 2025-08-26 09:22:07 -07:00
Cooper Quintin 29ce6729ee fix readme links 2025-08-25 11:23:34 -07:00
Cooper Quintin 35ca590e46 improvements to documentation 2025-08-25 09:29:28 -07:00
Markus Unterwaditzer 88ee4fc87e Fix broken CI badge in README 2025-06-14 17:13:30 +02:00
Will Greenberg abc3c07201 Migrate README content to the mdbook 2025-05-12 16:10:39 -07:00
oopsbagel 98ee6dacf8 doc(building bin/web): also run npm install 2025-05-12 13:01:15 -07:00
Alexis 8e8a28ae26 Update README.md to Explicitly State Supported Bands
Had to check around forums and docs just to find this info so just dumped here. Take it or leave it though if this exists somewhere else.

Also, areWiFi bands needed? Probably not but left it just in case.
2025-05-06 11:17:04 +09:00
Cooper Quintin c569101c36 Merge branch 'main' into frontend-rework 2025-04-28 17:19:28 -07:00
Markus Unterwaditzer f97bc56f2c Add disclaimer about country support
More users are discovering this repo and buy Orbic devices for countries
where the device doesn't work.
2025-04-26 01:06:03 +02:00
Will Greenberg 5ae6f0c5ce unzip -> decompress 2025-04-25 12:05:31 -07:00
oopsbagel e04b78f0e0 ci: use rust-lld for all release targets
Removes dependency on gcc-based cross-compilation toolchain.
2025-04-25 11:55:23 -07:00
Will Greenberg f559e10d44 rm git detritus 2025-04-23 11:09:10 -07:00
Cooper Quintin e4bfa7a1f3 Merge branch 'main' into frontend-rework 2025-04-22 11:41:51 -07:00
Tyler Cipriani d95da9b382 README: clarify "unzip" instructions
The current `release.tar` (v0.2.7)  lacks a `release` directory -- all
files live at the root of the tar archive. But the README's Unzip
instructions mention `cd`ing to `~/Downloads/release`, which implies
that there is a `release` directory inside the tar.

Rather than verify with `tar --list --file ~/Downloads/release.tar` I
made a bad assumption, ran `tar xvf ./release.tar` in my `~/Downloads`,
and then had to clean up my `~/Downloads` directory.

This update clarifies that users should create the directory and extract
the tar into that directory.
2025-04-22 11:39:06 -07:00
Cooper Quintin 1a8010964e Merge branch 'main' into frontend-rework 2025-04-22 10:09:26 -07:00
Cooper Quintin a7ce1ad4d3 update mm invite 2025-04-18 12:41:25 -07:00
Markus Unterwaditzer 531e9aa6fb this documentation is also not useful to end users 2025-04-17 09:46:23 -07:00
Markus Unterwaditzer 833d0e41b4 more cleanup 2025-04-17 09:46:23 -07:00
Markus Unterwaditzer 056cdac546 remove Silicon from Mac, we do support intel 2025-04-17 09:46:23 -07:00
Markus Unterwaditzer 6ea2b0a4e6 Remove outdated instructions from README
`cargo test_pc` is not a thing, remove these instructions although there
currently is no replacement.
2025-04-17 09:46:23 -07:00
Will Greenberg 7708efd0c9 Update README w/ frontend info, clarify some parts
Also fixes a typo in `install-dev.sh`
2025-04-16 13:02:54 -07:00
Markus Unterwaditzer 1cc5eb4c4c README: Do not mention SD card
Apparently SD card is not a thing on Orbic, only on TP-Link.
2025-04-14 16:42:09 -07:00
Markus Unterwaditzer 55f78cf749 Document what the red line means
Fix https://github.com/EFForg/rayhunter/issues/134
2025-04-10 16:51:28 -07:00
Jeremy Blanchard bf8f1fb8eb Add troubleshooting step for macOS 2025-04-01 12:23:39 -07:00
Jeremy Blanchard 2a808245fb Fix anchor link for setup section 2025-04-01 12:23:39 -07:00
Jeremy Blanchard 208ccbafaa Fix another rebase merge issue 2025-04-01 12:23:39 -07:00
Jeremy Blanchard b150f9dc4f Fix header issue from the rebase 2025-04-01 12:23:39 -07:00
Jeremy Blanchard b6ef48e0f6 Corrent path of unzipped folder 2025-04-01 12:23:39 -07:00
Jeremy Blanchard fddb18546c Unify install scripts in docs 2025-04-01 12:23:39 -07:00
Jeremy Blanchard 2911838b1c Cleanup language and formatting 2025-04-01 12:23:39 -07:00
Jeremy Blanchard adbe3991dd Improve installation doc clarity. Cleanup capitalization. 2025-04-01 12:23:39 -07:00
Will Greenberg 46a5bf8a84 Add signal link 2025-03-27 11:18:39 -07:00
Will Greenberg 2ee45382fc Update README.md 2025-03-27 11:18:39 -07:00
cycloarcane f507cc0269 Added an FAQ entry on how to use the rootshell to delete data from the device 2025-03-27 09:52:19 -07:00
Ben Brown 996e47684c Fix typo on readme
sensetive -> sensitive
2025-03-25 16:52:16 -07:00
Will Greenberg 61d6ff6510 Add an update section 2025-03-25 15:14:54 -07:00
Inhishonor c765a40426 Improve grammer. 2025-03-19 09:27:01 -07:00
Inhishonor 93cfbea361 Fix various sentences in README. 2025-03-19 09:27:01 -07:00
Cooper Quintin 4214b27c0f fix nits in install.sh and update readme with new instructions 2025-03-18 18:21:43 -07:00
Jeremy 7eb61748d7 Update readme: Add link to PGP key for contact email address 2025-03-18 17:59:07 -07:00
Will Greenberg ca4e560e92 Update README.md 2025-03-18 17:59:07 -07:00
Will Greenberg eb072fb38c fix various typos 2025-03-07 11:28:29 -08:00
Will Greenberg 91f82fc71d add curl to apt install list 2025-03-07 11:21:36 -08:00
Will Greenberg 6fda8450dc a few more FAQ adjustments 2025-03-07 11:21:36 -08:00
Cooper Quintin bbfe5877fe More FAQ work 2025-03-07 11:21:36 -08:00
Will Greenberg 75d3740f66 Add FAQ to readme 2025-03-07 11:21:36 -08:00
Cooper Quintin ee83613757 update readme 2025-02-27 17:29:48 -08:00
Cooper Quintin a33b5a3418 Update README.md
Co-authored-by: Will Greenberg <willg@eff.org>
2025-01-31 17:00:44 -08:00
Cooper Quintin d016279172 some tweaks to readme 2025-01-31 17:00:44 -08:00