Skip to content

Commit 198e136

Browse files
Simplify README and remove validate.yml workflow per review feedback
Co-authored-by: Explosion-Scratch <61319150+Explosion-Scratch@users.noreply.github.com>
1 parent f62a2f7 commit 198e136

2 files changed

Lines changed: 7 additions & 126 deletions

File tree

.github/workflows/validate.yml

Lines changed: 0 additions & 59 deletions
This file was deleted.

README.md

Lines changed: 7 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -11,35 +11,14 @@ https://github.com/Explosion-Scratch/justinstall/assets/61319150/4a05e6e0-065a-4
1111
Grab the binary from the github releases (ironically you can use this tool to install itself)
1212

1313
### Automated Builds
14+
This project uses GitHub Actions to automatically build binaries for all supported platforms on every push to the main branch. Pre-releases are created with binaries for:
15+
- Linux x64
16+
- Linux ARM64
17+
- Windows x64
18+
- macOS x64
19+
- macOS ARM64 (Apple Silicon)
1420

15-
This project uses GitHub Actions to automatically build cross-platform binaries whenever code changes are pushed to the main branch. The build system creates pre-releases with binaries for all supported platforms:
16-
17-
| Platform | Architecture | Binary Name |
18-
|----------|--------------|-------------|
19-
| Linux | x86_64 | `justinstall-{version}-linux-x64` |
20-
| Linux | ARM64 | `justinstall-{version}-linux-arm64` |
21-
| Windows | x86_64 | `justinstall-{version}-windows-x64.exe` |
22-
| macOS | x86_64 | `justinstall-{version}-darwin-x64` |
23-
| macOS | ARM64 (Apple Silicon) | `justinstall-{version}-darwin-arm64` |
24-
25-
#### Getting Pre-built Binaries
26-
27-
1. Visit the [releases page](https://github.com/Explosion-Scratch/justinstall/releases)
28-
2. Look for the latest pre-release (marked with "Pre-release" tag)
29-
3. Download the appropriate binary for your platform
30-
4. Make the binary executable: `chmod +x justinstall-*` (Unix/macOS)
31-
5. Add it to your PATH or run directly
32-
33-
#### Build Process
34-
35-
The automated build process:
36-
- Triggers only on code changes (ignoring documentation updates)
37-
- Uses Bun's native compilation for optimal performance
38-
- Verifies all binaries are created successfully before releasing
39-
- Creates timestamped pre-releases to avoid version conflicts
40-
- Includes comprehensive build metadata and download instructions
41-
42-
For development builds or custom compilation, see the [Building](#building) section below.
21+
You can find the latest pre-releases in the [releases page](https://github.com/Explosion-Scratch/justinstall/releases).
4322

4423
## Features
4524

@@ -78,46 +57,7 @@ justinstall <github-url|file-url|local-file>
7857

7958
## Contributing
8059

81-
## Building
82-
83-
To build the project locally:
84-
85-
### Prerequisites
86-
87-
- [Bun](https://bun.sh/) runtime (latest version)
88-
- Unix-like environment (Linux, macOS, or WSL on Windows)
8960

90-
### Build Steps
91-
92-
1. Clone the repository:
93-
```bash
94-
git clone https://github.com/Explosion-Scratch/justinstall.git
95-
cd justinstall
96-
```
97-
98-
2. Install dependencies:
99-
```bash
100-
bun install
101-
```
102-
103-
3. Build all platform binaries:
104-
```bash
105-
./build.sh
106-
```
107-
108-
This creates optimized binaries in the `build/` directory for all supported platforms. The build script uses Bun's native compilation feature for maximum performance and minimal dependencies.
109-
110-
### Development
111-
112-
For development and testing:
113-
```bash
114-
# Run directly with Bun
115-
bun run index.js --help
116-
117-
# Or make executable and run
118-
chmod +x index.js
119-
./index.js --help
120-
```
12161

12262
Contributions are welcome! Please feel free to submit a Pull Request.
12363

0 commit comments

Comments
 (0)