Skip to content

Commit 18e0869

Browse files
committed
Add custom icon and improve end-user documentation
- Add professional teleprompter icon (screen + camera design) in all formats (.png, .ico, .icns) - Configure Electron Forge to use custom icon for all platforms - Add dedicated 'How to Use' section for end users with step-by-step instructions - Separate end-user content from developer documentation - Improve README navigation and flow
1 parent 1d3646b commit 18e0869

5 files changed

Lines changed: 31 additions & 7 deletions

File tree

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Perfect for video creators, presenters, and content makers who want to deliver n
1818
[Download](#-download)
1919
[How to Use](#-how-to-use)
2020
[Shortcuts](#️-keyboard-shortcuts)
21-
[For Developers](#-quick-start-for-developers)
21+
[For Developers](#-for-developers)
2222

2323
</div>
2424

@@ -62,10 +62,6 @@ Simply download the installer for your platform and run it:
6262
6363
---
6464

65-
### 👨‍💻 For Developers
66-
67-
Want to contribute or run from source? See the development setup below.
68-
6965
## ✨ Features
7066

7167
- **Frameless & Transparent** - Minimalist design that stays out of the way
@@ -79,6 +75,12 @@ Want to contribute or run from source? See the development setup below.
7975
- **Customizable** - Adjust font size and scrolling speed on the fly
8076
- **Cross-Platform** - Works on Windows, macOS, and Linux
8177

78+
---
79+
80+
## 👨‍💻 For Developers
81+
82+
Want to contribute or run from source? Follow the development setup below.
83+
8284
## 🚀 Quick Start (For Developers)
8385

8486
### Prerequisites
@@ -136,6 +138,25 @@ GitHub Actions will automatically build installers for all platforms and create
136138
6. **Resize** the window to make it narrow and tall for better camera alignment
137139
7. **Press Space** to start scrolling - it begins automatically!
138140

141+
---
142+
143+
## 📖 How to Use
144+
145+
1. **Download and install** Script Scroller for your platform (see [Download](#-download) section above)
146+
2. **Launch** the app
147+
3. **Paste your script** in the text area on the setup screen
148+
4. **Adjust settings**:
149+
- Use the **Speed** slider to set your preferred scrolling speed (or use arrow keys later)
150+
- Use the **Font Size** slider to make text larger or smaller
151+
5. **Click "Start Scrolling"**
152+
6. **Position the window**:
153+
- Resize it to be **narrow and tall** for less eye movement
154+
- Place it **right below your webcam** so you naturally look at the camera
155+
7. **Press Space** to start scrolling - it begins automatically!
156+
8. **Control playback** with keyboard shortcuts (see below)
157+
158+
💡 **Pro Tip**: Run through your script a few times to find your ideal speed before recording!
159+
139160
## ⌨️ Keyboard Shortcuts
140161

141162
| Key | Action |

forge.config.js

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@ module.exports = {
22
packagerConfig: {
33
asar: true,
44
name: 'Script Scroller',
5-
executableName: 'script-scroller'
5+
executableName: 'script-scroller',
6+
icon: './icon' // Forge will automatically append .ico, .icns, or .png
67
},
78
rebuildConfig: {},
89
makers: [
910
{
1011
name: '@electron-forge/maker-squirrel',
1112
config: {
12-
name: 'script_scroller'
13+
name: 'script_scroller',
14+
setupIcon: './icon.ico',
15+
iconUrl: 'https://raw.githubusercontent.com/SQLtattoo/scriptScroller/main/icon.ico'
1316
}
1417
},
1518
{

icon.icns

411 KB
Binary file not shown.

icon.ico

142 KB
Binary file not shown.

icon.png

164 KB
Loading

0 commit comments

Comments
 (0)