Skip to content

Commit 20060eb

Browse files
author
andy
committed
Document platform support: WSL2 for Windows, CI-verified Linux distros
Explicit guidance was missing -- add a "Platform support" section to README.md (cross-referenced from GETTING_STARTED.md) documenting that CI now builds this clean on Debian/Ubuntu/Fedora/Rocky, and that Windows users should use WSL2 rather than Cygwin or a native build (matches the decision recorded on #18, now closed).
1 parent 498662b commit 20060eb

2 files changed

Lines changed: 30 additions & 1 deletion

File tree

‎GETTING_STARTED.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ This covers building, installing, and running this fork of ECCE on Debian
55
`main`'s CMake/CPack packaging, not the old `build_ecce`/recursive-make
66
workflow.
77

8+
CI also builds this clean on Ubuntu, Fedora, and Rocky Linux (RHEL
9+
family) — the steps below apply there too, adjusted for the distro's
10+
package manager. **On Windows, use WSL2** (not Cygwin, not a native
11+
build) — see the README's "Platform support" section for why.
12+
813
## 1. Install build dependencies
914

1015
```

‎README.md‎

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,31 @@ any particular change.
6363
## Installation and getting started
6464

6565
This covers a clean install on Debian 13 ("trixie") through to your first
66-
login. (Other distributions may work but aren't currently tested.)
66+
login.
67+
68+
### Platform support
69+
70+
CI (see `.github/workflows/build.yml`) builds this on every push against
71+
Debian, Ubuntu, Fedora, and Rocky Linux (a free RHEL rebuild, standing in
72+
for the RHEL family, which needs a subscription for a real CI runner) --
73+
all four currently build clean.
74+
75+
**Windows**: use **WSL2**, not Cygwin and not a native Windows build.
76+
WSL2 runs a real Linux kernel and userland (Ubuntu by default) under
77+
Windows, so the Ubuntu/Debian instructions below apply directly with no
78+
porting needed -- install WSL2, install a Debian or Ubuntu distro inside
79+
it, and follow this guide as-is. Native Windows and Cygwin are both a
80+
much larger undertaking: ECCE's process-launch and credential-handoff
81+
code (`fork()`+`execv()`, named-pipe/FIFO handoff, a remote-shell layer
82+
that assumes a POSIX login shell) is POSIX down to the architecture, not
83+
just the toolkit version -- real porting work, not a packaging exercise.
84+
See [#18](https://github.com/FriendsofECCE/ECCE/issues/18) for the fuller
85+
reasoning.
86+
87+
**macOS**: not supported yet, tracked in
88+
[#3](https://github.com/FriendsofECCE/ECCE/issues/3) -- also in CI (best
89+
effort, allowed to fail) to track progress with a real, current compile
90+
log.
6791

6892
### 1. Install build dependencies
6993

0 commit comments

Comments
 (0)