Revise README for improved clarity and details

Updated README to enhance clarity and structure, added download section, and clarified features.
This commit is contained in:
h3p 2026-01-23 14:27:36 +01:00 committed by GitHub
parent 577723a374
commit 6f2a6adbfa
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,33 +1,88 @@
# Neon Vision Editor
<p align="center">
<img src="NeonVision%20Editor.png" alt="NeonVision Editor Logo" width="200"/>
<img src="NeonVision%20Editor.png" alt="Neon Vision Editor Logo" width="200"/>
</p>
## About
MacOS 26 App (currently beta).
NeonVision Editor is a lightweight and modern text editor built for speed and simplicity.
It provides instant syntax highlighting for a wide range of standard programming languages, making it easy to quickly inspect, edit, or prototype code.
Designed with developers in mind, NeonVision Editor offers a distraction-free interface that emphasizes performance and readability.
Whether you need to open large files, preview code snippets, or perform quick edits, it delivers a streamlined workflow without unnecessary overhead.
### Key Highlights
- **Fast loading** even with large code files
- **Syntax highlighting** for common programming languages (Python, C, C++, JavaScript, HTML, CSS, and more)
- **Minimal design** focused on readability and ease of use
- **Lightweight footprint** runs smoothly without draining resources
- Optimized for **macOS 26 (Tahoe)**
<h1 align="center">Neon Vision Editor</h1>
<p align="center">
<img src="Neon Vision Editor.png" alt="NeonVision Editor App" width="900"/>
A lightweight, modern macOS text editor focused on speed, readability, and fast syntax highlighting.
</p>
## Installation
---
Neon Vision Editor is a lightweight, modern macOS text editor focused on **speed, readability, and fast syntax highlighting**.
It is intentionally minimal: quick edits, fast file access, no IDE bloat.
Clone this repository and open the project:
> Status: **alpha / beta**
> Platform target: **macOS 26 (Tahoe)**
## Download
Prebuilt binaries are available via **GitHub Releases**.
- Latest release: **v0.2.3-alpha** (23 Jan 2026)
- Architecture: Apple Silicon (Intel not tested)
- Notarization: *not yet*
If you dont want to build from source, this is the recommended path.
---
## Why this exists
Modern IDEs are powerful but heavy.
Classic macOS editors are fast but stagnant.
Neon Vision Editor sits in between:
- Open files instantly
- Read code comfortably
- Edit without friction
- Close the app without guilt
No background indexing. No telemetry. No plugin sprawl.
---
## Features
- Fast loading, including large text files
- Syntax highlighting for common languages
(Python, C/C++, JavaScript, HTML, CSS, and others)
- Clean, minimal UI optimized for readability
- Native macOS 26 (Tahoe) look & behavior
- Built with Swift and AppKit
<p align="left">
<img src="Neon%20Vision%20Editor.png" alt="Neon Vision Editor App" width="600"/>
</p>
---
## Non-goals (by design)
- ❌ No plugin system (for now)
- ❌ No project/workspace management
- ❌ No code intelligence (LSP, autocomplete, refactors)
- ❌ No Electron, no cross-platform abstraction layer
This is **not** an IDE. That is intentional.
---
## Requirements
- macOS 26 (Tahoe)
- Xcode compatible with macOS 26 toolchain
- Apple Silicon recommended
---
## Build from source
```bash
git clone https://github.com/your-username/neon-vision-editor.git
git clone https://github.com/h3pdesign/Neon-Vision-Editor.git
cd Neon-Vision-Editor
open "Neon Vision Editor.xcodeproj"