Skip to content

Commit 8f5f65c

Browse files
committed
update icon and bug fixes
1 parent b3c9742 commit 8f5f65c

11 files changed

Lines changed: 127 additions & 66 deletions

File tree

README.md

Lines changed: 16 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# CineScreen
22

3+
![Version](https://img.shields.io/github/v/release/jasonzh0/CineScreen)
4+
5+
<div align="center">
6+
<img src="src/assets/icon.png" alt="CineScreen Icon" width="128">
7+
</div>
8+
39
A professional macOS screen recording application built with Electron that records your screen without the native cursor, tracks mouse movements separately, and provides a powerful post-processing studio for creating polished, cinematic screen recordings.
410

511
### Result
@@ -71,40 +77,20 @@ Support for Intel Macs (x64) and other platforms may be added in the future.
7177
- **Vite** - Fast build tool for renderer process
7278
- **Native Swift** - Mouse button state tracking
7379

74-
## Architecture
75-
76-
The application follows a modular architecture:
77-
78-
- **Main Process** (`src/main/`) - Handles screen capture, mouse tracking, and window management
79-
- **Renderer Process** (`src/renderer/`) - UI for capture window and studio editor
80-
- **Processing** (`src/processing/`) - Video processing, cursor rendering, zoom effects, and motion blur
81-
- `cursor-utils.ts` - Shared cursor utilities (interpolation, easing, hotspots, click animations)
82-
- `smooth-motion.ts` - Spring physics and SmoothDamp algorithms for glide effects
83-
- `motion-blur.ts` - Directional motion blur using convolution kernels
84-
- `sharp-renderer.ts` - Frame-by-frame video rendering with Sharp
85-
- `zoom-tracker.ts` - Zoom region calculation and smoothing
86-
- **Native Module** (`native/`) - Swift-based mouse button state detection
87-
8880
## Installation
8981

90-
### Prerequisites
91-
- macOS (required for screen recording APIs)
92-
- Node.js 18+ and npm
93-
- Xcode Command Line Tools (for native module compilation)
82+
### Download from GitHub Releases
9483

95-
### Setup
84+
1. Go to the [Releases page](https://github.com/jasonzh0/CineScreen/releases) on GitHub
85+
2. Download the latest `.dmg` file from the assets section
86+
3. Open the downloaded DMG file
87+
4. Drag CineScreen to your Applications folder
88+
5. Launch CineScreen from Applications
9689

97-
```bash
98-
# Clone the repository
99-
git clone <repository-url>
100-
cd CineScreen
101-
102-
# Install dependencies
103-
npm install
104-
105-
# Build native modules
106-
npm run build:native
107-
```
90+
**Note:** On first launch, macOS may warn you that the app is from an unidentified developer. To allow it:
91+
- Right-click (or Control-click) the app and select "Open"
92+
- Click "Open" in the security dialog
93+
- Or go to System Settings > Privacy & Security and click "Open Anyway" next to the warning message
10894

10995
## Development
11096

build/icon.png

986 KB
Loading

0 commit comments

Comments
 (0)