Skip to content

Commit 25659bc

Browse files
authored
Create README.md
- Adds top screenshot (Sample_1.png) - Describes features, requirements and tested models (gemma3:12b default, mistral:latest, aya-expanse:8b, gpt-oss:20b, gpt-oss:120b-cloud) - Includes install/build instructions and shortcuts - Adds licensing note: code under PolyForm Noncommercial 1.0.0, assets under CC BY-NC 4.0
1 parent c77fc29 commit 25659bc

File tree

1 file changed

+134
-0
lines changed

1 file changed

+134
-0
lines changed

README.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
![DeepLocal Screenshot](Sample_1.png)
2+
3+
# DeepLocal, Offline Translator (WPF + Ollama)
4+
5+
### DeepLocal is a clean WPF desktop app that brings DeepL-style translation fully offline via Ollama. Two-pane UI, auto-detect, swap, and model picker (default: gemma3:12b). Built with .NET 8.
6+
7+
# ✨ Features
8+
9+
Interface inspired by DeepL: two panels (source → translation)
10+
11+
Auto-detect of the source language (the selector automatically switches to the recognized language)
12+
13+
Coherent swap (swaps texts and languages without forcing English)
14+
15+
Ollama model selector (default gemma3:12b; aya-expanse:8b, gpt-oss:120b-cloud)
16+
17+
Quick actions: Paste, Copy, Translate ▶️
18+
19+
Tray app: starts minimized, double-click to show/hide, right-click menu
20+
21+
Window position anchored to the bottom-right when it reappears from the tray
22+
23+
Main supported languages (IT, EN, ES, FR, DE, PT, RU, HE, JA, ZH). For unsupported languages: “language not supported”
24+
25+
# 📦 Requirements
26+
27+
Windows 10/11
28+
29+
Ollama running at http://127.0.0.1:11434
30+
31+
.NET 8 SDK (only if you want to build from source)
32+
33+
# ✅ Compatible models (tested)
34+
35+
- gemma3:12b (Default)
36+
37+
- mistral:latest
38+
39+
- aya-expanse:8b
40+
41+
- gpt-oss:20b
42+
43+
- gpt-oss:120b-cloud
44+
45+
Quick model installation (Ollama):
46+
```bash
47+
ollama pull gemma3:12b
48+
ollama pull mistral:latest
49+
ollama pull aya-expanse:8b
50+
ollama pull gpt-oss:20b
51+
# If available in your instance:
52+
ollama pull gpt-oss:120b-cloud
53+
```
54+
55+
DeepLocal selects gemma3:12b by default. You can change the model from the menu at the top right.
56+
Note: gpt-oss:120b-cloud may not be available on all local installations; in that case use gemma3:12b or one of the other listed models.
57+
58+
# 🚀 Installation (end users)
59+
60+
Download the installer from the Releases section.
61+
62+
Run the setup.
63+
64+
Launch DeepLocal (it stays in the tray): double-click the 🌎 icon to open/close.
65+
66+
In Options ⚙️ you can enable Start with Windows.
67+
68+
# 🧑‍💻 Build from source
69+
```bash
70+
git clone https://github.com/<your-user>/DeepLocal.git
71+
cd DeepLocal
72+
dotnet build
73+
dotnet run
74+
```
75+
76+
Main structure:
77+
```bash
78+
DeepLocal.csproj
79+
App.xaml / App.xaml.cs
80+
MainWindow.xaml / MainWindow.xaml.cs
81+
Assets/ (icons and images)
82+
```
83+
# ⌨️ Shortcuts
84+
85+
Ctrl+V paste into source
86+
87+
Ctrl+C copy the translation
88+
89+
Enter start translation
90+
91+
Double-click the tray icon show/hide
92+
93+
Right-click the tray icon: Open / Exit
94+
95+
# 🐞 Troubleshooting
96+
97+
“END” at the end: removed in recent versions; update if you still see it.
98+
99+
Window doesn’t reappear: check the tray icon and double-click it.
100+
101+
Model not found: run ollama pull <model> and make sure Ollama is running.
102+
103+
# 🤝 Contributing
104+
105+
Fork → branch feat/feature-name
106+
107+
Keep XAML/Assets style consistent
108+
109+
Submit a PR with description and screenshots
110+
111+
# 📣 Support & Donations
112+
113+
If DeepLocal helps you, even $1 is a “hey friend, thanks!” ❤️
114+
115+
Liberapay: https://liberapay.com/MetaDarko/donate
116+
117+
Bitcoin: [1NjV2CfyLw42Ej9UmZEcroyqnmmKMJNCUx](https://www.blockchain.com/explorer/addresses/btc/1NjV2CfyLw42Ej9UmZEcroyqnmmKMJNCUx)
118+
119+
@MetaDarko: https://github.com/ShinRalexis
120+
121+
For bugs/ideas open an Issue including app version, Windows version, steps, and screenshots.
122+
123+
# 📝 Licenses
124+
125+
Code (MIT)
126+
Copyright © 2025 MetaDarko.
127+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: the above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
128+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED.
129+
130+
Images/Assets (CC BY 4.0)
131+
/Sample_1.png and other graphic assets are © 2025 MetaDarko and distributed under Creative Commons Attribution 4.0 International: you may use them freely, including commercially, provided that you attribute “MetaDarko DeepLocal” and indicate any changes.
132+
Full text: https://creativecommons.org/licenses/by/4.0/
133+
134+
In short: the rights remain yours, but anyone can freely use the code and images (with attribution for assets).

0 commit comments

Comments
 (0)