diff options
| author | haoyuren <13851610112@163.com> | 2026-03-13 01:37:50 -0500 |
|---|---|---|
| committer | haoyuren <13851610112@163.com> | 2026-03-13 01:37:50 -0500 |
| commit | 1f68cb8a5de45c8b697ca74085cd5aae2c361787 (patch) | |
| tree | 3cdb12870eadcd601c88af21efa27ec596b476eb /README.md | |
| parent | 8b3b3be550307598e84c59e3d708e6ee9a3e1beb (diff) | |
Update logo, app icon, fix shutdown crash, add README
- Simplified logo: cosmic latte cup on brown background with turquoise
liquid and sparkle stars
- Square app icon (.icns) for macOS dock
- Fix crash on window close: guard all IPC sends against destroyed window
- Include ws/chokidar/diff-match-patch in packaged app
- Add README with features and install instructions
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5bdaaa2 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# LatteX + +<p align="center"> + <img src="resources/logo.svg" width="128" height="128" alt="LatteX logo"> +</p> + +<p align="center"> + LaTeX editor with real-time Overleaf sync, themed in Cosmic Latte. +</p> + +## Features + +- **Real-time Overleaf sync** — WebSocket-based OT collaboration, live co-editing +- **Bidirectional file sync** — edit `.tex` files on disk (e.g. with Claude Code in the integrated terminal) and changes sync to Overleaf automatically +- **Local LaTeX compilation** — compile PDFs locally with `latexmk`, no Overleaf compile limits +- **PDF viewer** — built-in viewer with SyncTeX forward/inverse search, pinch-to-zoom +- **LaTeX autocomplete** — commands, environments, `\ref`, `\cite`, file paths +- **Comments & review** — inline comment highlights with review panel +- **Collaborator cursors** — see other editors' positions in real-time +- **Project chat** — real-time chat panel +- **Integrated terminal** — built-in terminal for CLI tools + +## Install + +Download the latest `.dmg` from [Releases](https://github.com/YurenHao0426/lattex/releases). + +> **Note:** This is an unsigned build. On first launch, right-click → Open, or allow it in System Settings → Privacy & Security. + +### Requirements + +- macOS (Apple Silicon) +- [TeX Live](https://www.tug.org/texlive/) or [MacTeX](https://www.tug.org/mactex/) for local compilation + +## Development + +```bash +npm install +npm run dev +``` + +### Build + +```bash +npm run build +npx electron-builder --mac dmg +``` + +## License + +[AGPL-3.0](LICENSE) |
