You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: cross-platform installation for macOS, Linux, and Windows
Installation docs previously assumed Linux. Now covers all platforms:
README.md:
- New Prerequisites section with per-platform build dep table
(macOS/Ubuntu/Fedora/Arch/Windows/Docker)
- Documents CMake + Go requirement for BoringSSL compilation
book/src/getting-started/installation.md:
- Full instructions for macOS (Homebrew), Linux (Ubuntu/Fedora/Arch),
Windows (native MSVC and WSL2), and Docker
- Chrome installation per platform
- Troubleshooting section: BoringSSL build failures, Chrome not found,
openssl-sys conflicts
book/src/contributing/development-setup.md:
- Cross-references Installation for platform setup
- IDE setup table (VS Code, JetBrains, Neovim, Emacs)
- Platform-specific notes for macOS, Windows, Linux
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
cargo test -p palimpsest-fetch --test stealth_test -- --ignored --nocapture --test-threads=1
42
+
33
43
# Single crate
34
44
cargo test -p palimpsest-frontier
35
45
```
36
46
37
47
## Pre-Commit Checks
38
48
39
-
Before submitting a PR, run:
49
+
Before submitting a PR:
40
50
41
51
```bash
42
-
cargo fmt --check # Formatting
52
+
cargo fmt --check # Formatting
43
53
cargo clippy -- -D warnings # Lints (must be warning-free)
44
-
cargo test --workspace # All tests pass
54
+
cargo test --workspace # All tests pass
45
55
```
46
56
47
57
## IDE Setup
48
58
49
-
`rust-analyzer` is recommended. The workspace `Cargo.toml` at the project root configures all 15 crates automatically.
59
+
**rust-analyzer** is recommended for all editors. The workspace `Cargo.toml` at the project root configures all 15 crates automatically.
60
+
61
+
| Editor | Setup |
62
+
|---|---|
63
+
| VS Code | Install `rust-analyzer` extension |
64
+
| JetBrains (CLion/RustRover) | Built-in Rust support |
65
+
| Neovim |`mason.nvim` → install `rust-analyzer`|
66
+
| Emacs |`lsp-mode` + `rustic`|
50
67
51
68
## Docker Testing
52
69
53
70
```bash
54
71
docker build -t palimpsest .
55
72
docker run palimpsest --help
56
73
```
74
+
75
+
## Platform Notes
76
+
77
+
### macOS
78
+
79
+
BoringSSL builds cleanly with Xcode command line tools + Homebrew CMake + Go. No special flags needed.
80
+
81
+
### Windows (MSVC)
82
+
83
+
Requires Visual Studio Build Tools with the "Desktop development with C++" workload. CMake and Go must be in `PATH`. WSL2 is the recommended alternative for a smoother experience.
84
+
85
+
### Linux
86
+
87
+
All major distributions work. Ensure `cmake`, `go`, and `clang` (or `gcc`) are installed. See [Installation](../getting-started/installation.md) for distro-specific package commands.
Palimpsest uses [wreq](https://github.com/0x676e67/wreq) with BoringSSL for TLS fingerprint impersonation. BoringSSL is compiled from source during `cargo build`, which requires CMake, a C compiler, and Go.
17
+
18
+
## macOS
11
19
12
20
```bash
21
+
# Install Rust
22
+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
0 commit comments