diff --git a/README.md b/README.md index c8ecd51..4e684ac 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ # Avida-ED-App-Builder -A repository for tooling to make single-file executables or installers for Windows/MacOS/Linux for Avida-ED versions 3 and 4. \ No newline at end of file +A repository for tooling to make single-file executables or installers for Windows/MacOS/Linux for Avida-ED versions 3 and 4. + +## Layout + +``` +Avida-ED-App-Builder/ +├── apps/ +│ ├── v3/ # holds fetched Avida-ED 3 webroot (via compose target) +│ └── v4/ # holds fetched Avida-ED 4 webroot (via compose target) +├── packaging/ +│ ├── linux/ +│ │ ├── Dockerfile.appimage +│ │ ├── AppRun +│ │ ├── make_appimage.sh +│ │ └── desktop/avidaed.desktop +│ ├── mac/ +│ │ ├── make_macos_bundle.sh +│ │ └── Info.plist.tmpl +│ └── windows/ +│ ├── make_windows_sfx.ps1 +│ ├── 7z.sfx # 7-Zip SFX module (binary, small) +│ └── config.txt # SFX config for silent extract+run +├── server-ui/ # Rust (wry + tiny-http) single-binary app +│ ├── Cargo.toml +│ ├── build.rs +│ └── src/main.rs +├── tools/ +│ ├── Dockerfile.fetch # pulls known-good assets (from aed-docker or URL) +│ ├── fetch_assets.sh +│ └── inject_webroot.rs # tiny helper to copy chosen webroot into ./server-ui/webroot/ +├── docker-compose.yml +├── Makefile +└── README.md +``` +