Skip to content

Commit 6e2c996

Browse files
committed
feat: update .gitignore to include installers directory and enhance README with installation and development instructions
1 parent 254b8d2 commit 6e2c996

4 files changed

Lines changed: 71 additions & 10 deletions

File tree

circle-camera/.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@ dist
1212
dist-ssr
1313
*.local
1414

15+
# Keep installers directory but ignore other build artifacts
16+
/src-tauri/target
17+
!/installers
18+
1519
# Editor directories and files
1620
.vscode/*
1721
!.vscode/extensions.json

circle-camera/README.md

Lines changed: 65 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,72 @@
1-
# Tauri + Vue + TypeScript
1+
# Circle Camera
22

3-
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
3+
A simple Tauri app that displays your webcam in a circle. Perfect for screen recordings when you want to include your webcam feed without taking up too much space.
44

5-
## Recommended IDE Setup
5+
## Features
66

7-
- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
7+
- Circular webcam display
8+
- Transparent background
9+
- Draggable window
10+
- Camera selection
11+
- Resizable
12+
- Controls only visible on hover
813

9-
## Type Support For `.vue` Imports in TS
14+
## Installation
1015

11-
Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates. However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can enable Volar's Take Over mode by following these steps:
16+
### macOS
1217

13-
1. Run `Extensions: Show Built-in Extensions` from VS Code's command palette, look for `TypeScript and JavaScript Language Features`, then right click and select `Disable (Workspace)`. By default, Take Over mode will enable itself if the default TypeScript extension is disabled.
14-
2. Reload the VS Code window by running `Developer: Reload Window` from the command palette.
18+
Download the latest DMG installer from the [installers](/installers) directory and open it.
1519

16-
You can learn more about Take Over mode [here](https://github.com/johnsoncodehk/volar/discussions/471).
20+
## Development
21+
22+
### Prerequisites
23+
24+
- Node.js (v16 or later)
25+
- pnpm
26+
- Rust and Cargo
27+
28+
### Setup
29+
30+
1. Clone the repository
31+
2. Install dependencies:
32+
33+
```bash
34+
pnpm install
35+
```
36+
37+
### Development
38+
39+
Run the app in development mode:
40+
41+
```bash
42+
pnpm tauri dev
43+
```
44+
45+
### Building
46+
47+
Build the app for production:
48+
49+
```bash
50+
pnpm build:installer
51+
```
52+
53+
This will create installers in the `installers` directory.
54+
55+
### Updating the App Icon
56+
57+
1. Replace the `public/icon.svg` file with your own SVG icon
58+
2. Generate the app icons:
59+
60+
```bash
61+
pnpm icons
62+
```
63+
64+
3. Rebuild the app:
65+
66+
```bash
67+
pnpm build:installer
68+
```
69+
70+
## License
71+
72+
MIT
5.47 MB
Binary file not shown.

circle-camera/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
"preview": "vite preview",
1010
"tauri": "tauri",
1111
"icons": "pnpm tauri icon public/icon.svg",
12-
"build:macos": "pnpm tauri build --target aarch64-apple-darwin"
12+
"build:macos": "pnpm tauri build --target aarch64-apple-darwin",
13+
"build:installer": "pnpm tauri build && mkdir -p installers && cp src-tauri/target/release/bundle/dmg/circle-camera_*.dmg installers/"
1314
},
1415
"dependencies": {
1516
"vue": "^3.5.13",

0 commit comments

Comments
 (0)