Skip to content

Commit eaaddb4

Browse files
author
Lukas Geiger
committed
docs: improve CodeBox discoverability
1 parent f44ff0c commit eaaddb4

2 files changed

Lines changed: 34 additions & 5 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
66
## [Unreleased]
77

88
### Hinzugefügt
9+
- README-Discoverability für GitHub/Web-Suche geschärft: englischer SEO-Einstieg,
10+
CodeBox-Namenskollision erklärt, Quickstart und präzisere Suchbegriffe ergänzt.
911
- Headless-Smoke-Test für MainWindow-Instanziierung
1012
- Optionale LSP-Runtime-Tests für `python-lsp-server[all]`:
1113
Diagnostics bei Syntaxfehlern und Completion über `pylsp`.

README.md

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
1-
# CodeBox
1+
# CodeBox - local PySide6 desktop code editor
22

3-
Mehrsprachiger Desktop-Codeeditor auf Basis von PySide6.
4-
Multi-language desktop code editor built with PySide6.
3+
CodeBox is a local-first desktop IDE for Windows developers who want a
4+
lightweight PySide6 code editor with tabs, a project tree, an integrated
5+
terminal, Git helpers, syntax highlighting and Language Server Protocol
6+
diagnostics.
57

6-
CodeBox ist aus PythonBox v8 hervorgegangen und bündelt Editor, Projektbaum,
7-
Terminal sowie erste LSP- und API-Grundlagen in einer lokalen IDE.
8+
Mehrsprachiger Desktop-Codeeditor auf Basis von PySide6. CodeBox ist aus
9+
PythonBox v8 hervorgegangen und bündelt Editor, Projektbaum, Terminal sowie
10+
erste LSP- und API-Grundlagen in einer lokalen IDE.
11+
12+
## Why CodeBox
13+
14+
- Local-first: edit files on your machine without cloud accounts or telemetry.
15+
- PySide6 desktop stack: native Windows app behavior with a small Python codebase.
16+
- Multi-language workflow: Python, JavaScript, TypeScript, C++, Rust, Go and Java.
17+
- LSP-ready: diagnostics and completion can connect to installed language servers.
18+
- Dev-bricks ecosystem: companion to PythonBox and DevCenter for small local tools.
819

920
## Screenshot
1021

@@ -30,6 +41,14 @@ python main.py
3041

3142
Alternativ per Doppelklick auf `start.bat`.
3243

44+
### Quick start
45+
46+
1. Clone `https://github.com/dev-bricks/CodeBox`.
47+
2. Install dependencies with `pip install -r requirements.txt`.
48+
3. Run `python main.py`.
49+
4. Optional: install language servers such as `python-lsp-server[all]` or
50+
`typescript-language-server` for diagnostics and completion.
51+
3352
### Voraussetzungen / Requirements
3453

3554
- Python 3.10+
@@ -86,6 +105,14 @@ config/ Konfigurationsdateien
86105
themes/ QSS-Themes
87106
```
88107

108+
## Discovery keywords
109+
110+
CodeBox is best described as a local PySide6 code editor, Windows desktop IDE,
111+
offline code editor, LSP-enabled Python editor and lightweight multi-language
112+
developer tool. The repository name collides with older projects called
113+
`codebox`, so searches are most precise with `dev-bricks CodeBox`,
114+
`CodeBox PySide6`, `CodeBox LSP editor` or `file-bricks/dev-bricks desktop IDE`.
115+
89116
## Status
90117

91118
Aktueller Stand: `DEV`, Version `0.1.0`

0 commit comments

Comments
 (0)