Skip to content

Commit 6a7c9de

Browse files
committed
Add logo, start.vbs launcher, and executable quick start docs
Include gitdock-logo.png in release zip so the dashboard icon renders. Add start.vbs for Windows to launch without a console window. Add Quick Start section to README with SmartScreen guidance.
1 parent 52533b8 commit 6a7c9de

4 files changed

Lines changed: 25 additions & 3 deletions

File tree

.github/workflows/build-release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,15 +45,15 @@ jobs:
4545
run: |
4646
New-Item -ItemType Directory -Force -Path release | Out-Null
4747
Copy-Item "dist\${{ matrix.exe }}" release\
48-
Copy-Item dashboard.html, workspace-setup.html release\
48+
Copy-Item dashboard.html, workspace-setup.html, gitdock-logo.png, start.vbs release\
4949
5050
- name: Prepare release folder (Unix)
5151
if: matrix.os != 'windows-latest'
5252
shell: bash
5353
run: |
5454
mkdir -p release
5555
cp "dist/${{ matrix.exe }}" release/
56-
cp dashboard.html workspace-setup.html release/
56+
cp dashboard.html workspace-setup.html gitdock-logo.png release/
5757
5858
- name: Create zip (Windows)
5959
if: matrix.os == 'windows-latest'

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,26 @@ sudo apt-get install -y openssh-client
216216

217217
---
218218

219-
## Step-by-Step Installation
219+
## Quick Start (Standalone Executable)
220+
221+
If you just want to run GitDock without installing Node.js or cloning the repo:
222+
223+
1. Go to the [latest release](https://github.com/gitdock-dev/gitdock/releases/latest) or download from [gitdock.dev](https://gitdock.dev)
224+
2. Download the zip for your platform (Windows, macOS, or Linux)
225+
3. Extract the zip to a folder of your choice
226+
4. Run the executable:
227+
- **Windows:** double-click `start.vbs` (runs without a console window) or `gitdock.exe` (shows server logs)
228+
- **macOS / Linux:** run `./gitdock` from a terminal
229+
230+
The dashboard opens automatically in your browser.
231+
232+
> **Windows note:** SmartScreen may warn that the app is unrecognized because the executable is not code-signed yet. Click **"More info"** then **"Run anyway"**. You can also right-click the zip before extracting, select **Properties**, and check **"Unblock"** to prevent this.
233+
234+
You still need **Git** and **GitHub CLI (gh)** installed and authenticated. See [Prerequisites](#prerequisites) below.
235+
236+
---
237+
238+
## Step-by-Step Installation (Developer)
220239

221240
### 1. Clone and install
222241

gitdock-logo.png

327 KB
Loading

start.vbs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Set shell = CreateObject("WScript.Shell")
2+
shell.CurrentDirectory = CreateObject("Scripting.FileSystemObject").GetParentFolderName(WScript.ScriptFullName)
3+
shell.Run "gitdock.exe", 0, False

0 commit comments

Comments
 (0)