Update .gitignore and remove obsolete documentation files
- Added new entries to .gitignore for build artifacts and macOS output directories to streamline the build process. - Deleted outdated documentation files: AUTH_LOGIN_FIX.md, AUTBOOT_CONFIGURATION.md, BACKEND_FIXES.md, BACKEND_STARTUP_FIX.md, BITCOIN_CORE_HEADLESS_FIX.md, BITCOIN_CORE_UI_COMPLETE.md, BITCOIN_STANDALONE_UI_COMPLETE.md, BITCOIN_UI_COMPLETE.md, BOOT_SEQUENCE_DIAGRAM.txt, and BUILD_COMMANDS_REFERENCE.txt to declutter the repository and remove unnecessary content.
This commit is contained in:
@@ -7,8 +7,8 @@ Helper scripts for building Archipelago OS images.
|
||||
### `build-backend.sh`
|
||||
Compiles the Archipelago Rust backend binary.
|
||||
- Output: `../build/backend/archipelago`
|
||||
- Requires: Rust toolchain
|
||||
- Optional: musl target for static binary
|
||||
- Requires: Rust toolchain (or Docker)
|
||||
- Builds for Linux x86_64
|
||||
|
||||
### `build-frontend.sh`
|
||||
Builds the Vue.js frontend for production.
|
||||
@@ -16,18 +16,6 @@ Builds the Vue.js frontend for production.
|
||||
- Requires: Node.js 18+, npm
|
||||
- Builds static files for serving
|
||||
|
||||
### `create-backend-apk.sh`
|
||||
Creates Alpine APK package from backend binary.
|
||||
- Output: `../apks/archipelago-backend-*.apk`
|
||||
- Includes: binary, systemd service, config files
|
||||
- Format: Alpine package format (tar.gz with metadata)
|
||||
|
||||
### `install-archipelago.sh`
|
||||
Installs Archipelago components into built image.
|
||||
- Called after image is created
|
||||
- Installs APK and frontend files
|
||||
- Configures services
|
||||
|
||||
### `convert-iso-to-disk.sh`
|
||||
Converts ISO image to raw disk image.
|
||||
- Input: ISO file
|
||||
@@ -36,19 +24,18 @@ Converts ISO image to raw disk image.
|
||||
|
||||
### `check-dependencies.sh`
|
||||
Checks if all build dependencies are available.
|
||||
- Checks: Rust, Node.js, Docker (if needed)
|
||||
- Checks: Rust, Node.js, Docker, xorriso
|
||||
- Provides installation instructions
|
||||
- Non-blocking (warns but continues)
|
||||
|
||||
### `setup-alpine-build.sh`
|
||||
Sets up Alpine build environment.
|
||||
- Installs Alpine build tools
|
||||
- Configures abuild keys
|
||||
- Only needed for native Alpine builds
|
||||
### `install-podman.sh`
|
||||
Installs Podman container runtime.
|
||||
- For use inside the target system
|
||||
- Configures rootless Podman
|
||||
|
||||
## Usage
|
||||
|
||||
These scripts are called automatically by the main build process. You typically don't need to run them manually, but you can for testing:
|
||||
These scripts are called automatically by the main build process. You can also run them manually for testing:
|
||||
|
||||
```bash
|
||||
# Build just the backend
|
||||
@@ -57,6 +44,6 @@ These scripts are called automatically by the main build process. You typically
|
||||
# Build just the frontend
|
||||
./scripts/build-frontend.sh
|
||||
|
||||
# Create APK package
|
||||
./scripts/create-backend-apk.sh
|
||||
# Check dependencies
|
||||
./scripts/check-dependencies.sh
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user