Neon-Vision-Editor/README.md

226 lines
7.8 KiB
Markdown
Raw Normal View History

2026-01-24 13:06:31 +00:00
<h1 align="center">Neon Vision Editor</h1>
2025-08-26 10:57:01 +00:00
<p align="center">
2026-02-06 13:40:50 +00:00
<img src="NeonVisionEditorIcon.png" alt="Neon Vision Editor Logo" width="200"/>
2025-08-26 10:57:01 +00:00
</p>
2026-02-06 14:10:41 +00:00
<h4 align="center">
A lightweight, modern editor focused on speed, readability, and automatic syntax highlighting.
2026-02-06 14:10:41 +00:00
</h4>
2026-02-06 14:10:12 +00:00
<p align="center">
Minimal by design: quick edits, fast file access, no IDE bloat.
</p>
2025-08-26 11:20:28 +00:00
2026-01-24 13:09:49 +00:00
<p align="center">
2026-02-17 23:25:17 +00:00
h3p apps is a focused portal for product docs, setup guides, and release workflows: <a href="https://apps-h3p.com"> >h3p apps</a>
2026-02-06 14:10:12 +00:00
</p>
2026-02-17 23:25:17 +00:00
2026-02-17 23:19:47 +00:00
<p align="center">
2026-02-17 23:25:17 +00:00
Release Download: <a href="https://github.com/h3pdesign/Neon-Vision-Editor/releases">GitHub Releases</a>
2026-02-17 23:19:47 +00:00
</p>
2025-08-26 10:57:01 +00:00
2026-02-17 23:25:17 +00:00
> Status: **active release**
2026-02-27 17:13:12 +00:00
> Latest release: **v0.4.32**
> Platform target: **macOS 26 (Tahoe)** compatible with **macOS Sequoia**
2026-01-24 13:20:47 +00:00
> Apple Silicon: tested / Intel: not tested
2025-08-26 10:57:01 +00:00
## Download
Prebuilt binaries are available on [GitHub Releases](https://github.com/h3pdesign/Neon-Vision-Editor/releases).
2026-02-27 17:13:12 +00:00
- Latest release: **v0.4.32**
2026-02-15 12:44:22 +00:00
- Apple AppStore [On the AppStore](https://apps.apple.com/de/app/neon-vision-editor/id6758950965)
- TestFlight beta: [Join here](https://testflight.apple.com/join/YWB2fGAP)
- Architecture: Apple Silicon (Intel not tested)
2026-02-15 12:44:22 +00:00
- Notarization: *is finally implemented*
## Getting Started (30 Seconds)
1. Install using `curl` or Homebrew (below), or download the latest `.zip`/`.dmg` from [Releases](https://github.com/h3pdesign/Neon-Vision-Editor/releases).
2. Move `Neon Vision Editor.app` to `/Applications`.
3. Launch the app.
4. Open a file with `Cmd+O`.
5. Use `Cmd+P` for Quick Open and `Cmd+F` for Find & Replace.
6. Toggle Vim mode with `Cmd+Shift+V` if needed.
2026-01-24 13:20:47 +00:00
## Install
### Quick install (curl)
Install the latest release directly:
```bash
curl -fsSL https://raw.githubusercontent.com/h3pdesign/Neon-Vision-Editor/main/scripts/install.sh | sh
```
Install without admin password prompts (user-local app folder):
```bash
curl -fsSL https://raw.githubusercontent.com/h3pdesign/Neon-Vision-Editor/main/scripts/install.sh | sh -s -- --appdir "$HOME/Applications"
```
### Homebrew
```bash
brew tap h3pdesign/tap
brew install --cask neon-vision-editor
```
2026-02-08 20:50:07 +00:00
Tap repository: [h3pdesign/homebrew-tap](https://github.com/h3pdesign/homebrew-tap)
If Homebrew asks for an admin password, it is usually because casks install into `/Applications`.
Use this to avoid that:
2026-01-24 13:20:47 +00:00
```bash
brew install --cask --appdir="$HOME/Applications" neon-vision-editor
```
2026-01-24 13:20:47 +00:00
### Gatekeeper (macOS 26 Tahoe)
2026-01-24 13:20:47 +00:00
If macOS blocks first launch:
1. Open **System Settings**.
2. Go to **Privacy & Security**.
3. In **Security**, find the blocked app message.
4. Click **Open Anyway**.
5. Confirm the dialog.
## Features
- Fast loading for regular and large text files.
- Tabbed editing with per-file language support.
- Automatic syntax highlighting for many languages and formats.
- AI Activity Log diagnostics window on macOS for startup/provider visibility.
- Full Flux/command-pattern action flow for deterministic editor command handling.
- Swift 6 concurrency hardening across critical runtime paths.
2026-02-15 12:44:22 +00:00
- Optional support purchase flow (StoreKit 2) in Settings.
- Cross-platform theme settings panel with improved settings organization.
- Inline code completion with Tab-to-accept ghost suggestions.
- Starter templates for all languages with one-click insert.
2026-02-09 18:43:56 +00:00
- Document-type handling for `.plist`, `.sh`, and general text so Finder/iOS can route those files straight into the editor.
- Toolbar Map card in the welcome tour now scales to fill a taller inner frame, keeping the button cards inside the border.
- Regex Find/Replace with Replace All.
- Project tree sidebar plus Quick Open (`Cmd+P`).
- Recursive project tree rendering for nested folders in the sidebar.
- Last-session restore now includes the previously opened project folder.
- Optional Vim mode (basic normal/insert workflow).
- Multi-window workflow with focused-window commands.
- Native Swift/AppKit editor experience.
- No telemetry.
2026-01-24 13:34:53 +00:00
<p align="left">
2026-02-06 13:44:13 +00:00
<img src="NeonVisionEditorApp.png" alt="Neon Vision Editor App" width="1100"/>
</p>
## Keyboard Shortcuts
| Shortcut | Action |
|---|---|
| `Cmd+N` | New Window |
| `Cmd+T` | New Tab |
| `Cmd+O` | Open File |
| `Cmd+S` | Save |
| `Cmd+W` | Close Tab |
| `Cmd+P` | Quick Open |
| `Cmd+F` | Find & Replace |
| `Cmd+Shift+V` | Toggle Vim Mode |
| `Cmd+Option+S` | Toggle Sidebar |
| `Cmd+Option+L` | Toggle Line Wrap |
| `Cmd+Shift+D` | Toggle Brain Dump Mode |
| `Tab` | Accept code completion (when shown) |
## Changelog
2026-02-27 17:13:12 +00:00
### v0.4.32 (summary)
2026-02-27 17:15:02 +00:00
- Added native macOS `SettingsLink` wiring for the menu bar entry so it opens the Settings scene through the system path.
- Improved macOS command integration by preserving the system app-settings command group and standard Settings routing behavior.
- Improved project-folder last-session restoration reliability by keeping security-scoped folder access active before rebuilding the sidebar tree.
- Fixed non-standard Settings shortcut mapping by restoring the macOS standard `Cmd+,` behavior.
- Fixed startup behavior when "Open with Blank Document" is enabled so launch always opens exactly one empty document.
2026-02-27 17:13:12 +00:00
2026-02-25 13:22:59 +00:00
### v0.4.31 (summary)
- Added an AI Activity Log on macOS with a dedicated diagnostics window and menu entry to inspect startup/provider events.
- Added centralized macOS app command wiring for settings, AI diagnostics, updater, editor actions, and window-level command routing.
- Added a full Flux/command-pattern redesign completed in a parallel session.
2026-02-25 13:22:59 +00:00
- Improved release automation resiliency in `scripts/release_all.sh` with fail-fast `gh` auth checks, workflow/runner prechecks, stricter workflow status handling, and retryable asset verification.
- Improved settings startup behavior to preserve user-selected tabs/preferences and avoid redundant refresh work when opening Settings.
### v0.4.30 (summary)
2026-02-24 14:46:44 +00:00
- Added a native macOS Markdown preview web view with template presets (Default, Docs, Article, Compact) and toolbar access.
- Added richer Markdown-to-HTML rendering for headings, lists, blockquotes, code fences, links, and inline formatting in preview mode.
- Improved Markdown code-block typography/spacing in preview so fenced blocks render with tighter, editor-like line density.
- Improved editor-to-binding synchronization safeguards while the text view has focus to prevent stale-state overwrites during active interaction.
- Fixed cursor/caret jump regressions where selection could unexpectedly snap to a much earlier position after paste/update timing races.
Full release history: [`CHANGELOG.md`](CHANGELOG.md)
## Known Limitations
- Intel Macs are not fully validated.
- Vim support is intentionally basic (not full Vim emulation).
- iOS/iPad editor functionality is still more limited than macOS.
## Privacy & Security
- Privacy policy: [`PRIVACY.md`](PRIVACY.md).
- API keys are stored in Keychain (`SecureTokenStore`), not `UserDefaults`.
- Network traffic uses HTTPS.
- No telemetry.
- External AI requests only occur when code completion is enabled and a provider is selected.
- Security policy and reporting details: [`SECURITY.md`](SECURITY.md).
## Release Integrity
2026-02-27 17:13:12 +00:00
- Tag: `v0.4.32`
- Tagged commit: `1c31306`
- Verify local tag target:
2026-02-06 19:34:10 +00:00
```bash
2026-02-27 17:13:12 +00:00
git rev-parse --verify v0.4.32
```
- Verify downloaded artifact checksum locally:
```bash
shasum -a 256 <downloaded-file>
```
## Requirements
- macOS 26 (Tahoe)
- Xcode compatible with macOS 26 toolchain
- Apple Silicon recommended
## Build from source
2025-08-26 10:57:01 +00:00
```bash
2026-01-24 12:51:23 +00:00
git clone https://github.com/h3pdesign/Neon-Vision-Editor.git
cd Neon-Vision-Editor
open "Neon Vision Editor.xcodeproj"
```
## Git hooks
To auto-increment Xcode `CURRENT_PROJECT_VERSION` on every commit:
```bash
scripts/install_git_hooks.sh
```
## Support
2026-01-24 17:15:37 +00:00
If you want to support development:
- [Patreon](https://www.patreon.com/h3p)
2026-02-09 05:57:36 +00:00
- [My site h3p.me](https://h3p.me/home)
## License
Neon Vision Editor is licensed under the MIT License.
See [`LICENSE`](LICENSE).