Skip to content

Commit 3013753

Browse files
committed
added README
1 parent 1cf6593 commit 3013753

2 files changed

Lines changed: 26 additions & 10 deletions

File tree

.github/workflows/release.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,21 @@ jobs:
133133
workflow_conclusion: success
134134
allow_forks: false
135135

136+
- name: Create Windows README
137+
run: |
138+
cat > artifacts/windows/README.txt << 'READMEEOF'
139+
CuePoint - Installation (unsigned app)
140+
141+
Step 1: Open CuePoint Setup.exe
142+
143+
Step 2: After you get a popup called "Windows protected your PC", click "More info"
144+
145+
Step 3: Click "Run anyway" (this happens because we do not pay 200 euros/year to sign the app with Microsoft)
146+
147+
Step 4: Install and enjoy
148+
READMEEOF
149+
echo "Created artifacts/windows/README.txt"
150+
136151
- name: Set up Python
137152
uses: actions/setup-python@v5
138153
with:
@@ -207,6 +222,7 @@ jobs:
207222
files: |
208223
artifacts/macos/*.dmg
209224
artifacts/windows/*.exe
225+
artifacts/windows/README.txt
210226
dist/sbom.spdx.json
211227
THIRD_PARTY_LICENSES.txt
212228
SHA256SUMS

scripts/create_dmg.sh

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,19 +65,19 @@ cp -R "dist/${APP_NAME}.app" "${DMG_DIR}/"
6565
echo "Creating Applications symlink..."
6666
ln -s /Applications "${DMG_DIR}/Applications"
6767

68-
# Create README
69-
cat > "${DMG_DIR}/README.txt" << EOF
70-
CuePoint ${VERSION}
68+
# Create README (gatekeeper / unsigned app instructions)
69+
cat > "${DMG_DIR}/README.txt" << 'EOF'
70+
CuePoint - Installation (unsigned app)
7171
72-
Installation:
73-
1. Drag CuePoint.app to the Applications folder
74-
2. Open Applications and launch CuePoint
72+
Step 1: Drag CuePoint into the Applications folder.
7573
76-
System Requirements:
77-
- macOS 10.15 or later
78-
- 100MB free disk space
74+
Step 2: Try to open the app - it will not let you. DO NOT MOVE TO BIN.
7975
80-
For support, visit: https://github.com/yourusername/cuepoint
76+
Step 3: Go to Settings -> Privacy & Security -> scroll until you see CuePoint and click "Always open".
77+
78+
Step 4: Try again opening the app from the Applications folder.
79+
80+
For support, visit: https://github.com/StuChain/CuePoint
8181
EOF
8282

8383
# Create initial DMG (read-write for layout configuration)

0 commit comments

Comments
 (0)