Skip to content

Commit 115f6cc

Browse files
author
Lukas Geiger
committed
docs: improve NoteSpaceLLM discoverability
1 parent 779d285 commit 115f6cc

5 files changed

Lines changed: 49 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
99
- Portierungsplan für Windows Store, Web/PWA, Android, iOS, macOS und Linux
1010
- Geplantes Austauschformat `notespacellm-workspace-v1.json` für Desktop-zu-Companion-Workflows
1111
- Erster Web/PWA-Companion unter `web_companion/` mit lokalem Workspace-Import, read-only Bericht-/Dokumentansicht und Export für Review-Notizen
12+
- README-Screenshot und SEO-Metadaten für den Web/PWA-Companion
1213
- Remote-Ollama-Anbindung: Konfigurierbare Server-URL pro Projekt
1314
- API-Key-Authentifizierung für Ollama-Proxies (Bearer Token)
1415
- GUI: URL- und API-Key-Felder im LLM-Einstellungsdialog

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,46 @@
44

55
# NoteSpaceLLM
66

7+
**Local NotebookLM alternative for private document analysis, RAG-assisted research, and multi-format report generation.**
8+
9+
NoteSpaceLLM is an offline-first PySide6 desktop app for working with PDFs,
10+
Word files, Markdown, mail exports, notes, and research folders. It keeps
11+
project data local by default, supports local or remote Ollama, OpenAI,
12+
Anthropic and Claude Code workflows, and exports analysis results to Markdown,
13+
PDF, DOCX, HTML and TXT. A lightweight Web/PWA Companion is now available for
14+
reviewing exported workspaces on Android, iOS and browser devices without
15+
uploading documents to a server.
16+
17+
**Best-fit searches:** NotebookLM alternative, local RAG document analysis,
18+
private document chat, PySide6 research tool, offline AI report generator,
19+
local-first document workflow.
20+
21+
## English quick start
22+
23+
```bash
24+
git clone https://github.com/file-bricks/NoteSpaceLLM.git
25+
cd NoteSpaceLLM
26+
pip install -r requirements.txt
27+
python main.py
28+
```
29+
30+
Run the test and compile smoke checks with:
31+
32+
```bash
33+
python -m unittest discover -s tests -v
34+
python -m compileall -q main.py manage_translations.py translator.py src
35+
cd web_companion
36+
node --test tests/library.test.mjs
37+
```
38+
39+
## Screenshots
40+
41+
![NoteSpaceLLM desktop main window](README/screenshots/main.png)
42+
43+
![NoteSpaceLLM Web/PWA Companion](README/screenshots/web-companion.png)
44+
45+
## Deutsch
46+
747
Ein lokaler, datenschutzfreundlicher Ersatz für Google NotebookLM zur Dokumentenanalyse und Berichterstellung.
848

949
## Features
@@ -21,7 +61,7 @@ Ein lokaler, datenschutzfreundlicher Ersatz für Google NotebookLM zur Dokumente
2161
- **Umlaut-sichere Oberfläche**: Deutsche UI-Texte verwenden echte Umlaute; der Übersetzungs-Scan vermeidet englische False Positives
2262
- **Profile**: Wiederverwendbare Ausgabeformat-Kombinationen
2363

24-
## Screenshot
64+
## Desktop-Screenshot
2565

2666
![NoteSpaceLLM Hauptfenster](README/screenshots/main.png)
2767

360 KB
Loading

web_companion/index.html

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
<head>
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1">
6-
<title>NoteSpaceLLM Companion</title>
7-
<meta name="description" content="Lokaler Web/PWA-Companion für exportierte NoteSpaceLLM-Workspaces.">
6+
<title>NoteSpaceLLM Web/PWA Companion</title>
7+
<meta name="description" content="Lokaler Web/PWA-Companion für exportierte NoteSpaceLLM-Workspaces: mobile Review-Notizen, Berichtsvorschau und Dokumentmetadaten ohne Server-Upload.">
8+
<meta name="keywords" content="NoteSpaceLLM, NotebookLM Alternative, local RAG, document analysis, privacy-first AI, PWA, document review">
9+
<meta property="og:title" content="NoteSpaceLLM Web/PWA Companion">
10+
<meta property="og:description" content="Read-only browser companion for exported NoteSpaceLLM workspaces with local review notes and no server upload.">
11+
<meta property="og:type" content="website">
812
<meta name="theme-color" content="#0c4a6e">
913
<link rel="manifest" href="./manifest.webmanifest">
1014
<link rel="stylesheet" href="./app.css">

web_companion/manifest.webmanifest

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
"background_color": "#f4efe6",
77
"theme_color": "#0c4a6e",
88
"lang": "de",
9-
"description": "Lokaler Web/PWA-Companion für exportierte NoteSpaceLLM-Workspaces."
9+
"description": "Lokaler Web/PWA-Companion für exportierte NoteSpaceLLM-Workspaces mit Review-Notizen ohne Server-Upload."
1010
}

0 commit comments

Comments
 (0)