Skip to content

Commit caef3bb

Browse files
ZFordDevZFordDev
authored
Refactor README for clarity and updates
Removed unnecessary comments and updated badge links. Adjusted system requirements and installation instructions for clarity.
1 parent 859957b commit caef3bb

1 file changed

Lines changed: 29 additions & 131 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 131 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,6 @@
1-
<!-- ========================================================= -->
2-
<!-- Standards Approval Badge -->
3-
<!-- ========================================================= -->
4-
<table align="right">
5-
<tr>
6-
<td>
7-
<img src="https://raw.githubusercontent.com/ZFordDev/ZFordDev/main/assets/standards-approved.svg" width="80" alt="ZFordDev Standards Approved Badge">
8-
</td>
9-
</tr>
10-
</table>
11-
12-
<!-- ========================================================= -->
13-
14-
<!-- Required Badges -->
15-
16-
<!-- ========================================================= -->
17-
181
[![Docs](https://img.shields.io/badge/DocsHub-docs.zford.dev-4F46E5?style=flat-square)](https://docs.zford.dev/docs/snapdockstudio/snapdock/)
192
![Status](https://img.shields.io/badge/Status-ACTIVE-4CAF50?style=flat-square)
20-
![Platforms](https://img.shields.io/badge/Platforms-Windows%20%7C%20Linux-blue?style=flat-square)
21-
22-
<!-- ========================================================= -->
23-
24-
<!-- Optional Badges (Uncomment if applicable) -->
25-
26-
<!-- ========================================================= -->
3+
![Platforms](https://img.shields.io/badge/Platforms-Windows%20%7C%20Linux-blue?style=flat-square)
274

285
[![itch.io](https://img.shields.io/badge/itch.io-SnapDock-FA5C5C?style=flat-square)](https://zforddev.itch.io/snapdock)
296
![Downloads](https://img.shields.io/github/downloads/ZFordDev/SnapDock/total?style=flat-square)
@@ -34,9 +11,7 @@
3411
> *A Minimal, Modern Markdown Editor*
3512
>
3613
> **Status:**
37-
> Stable (V2 Classic) • Actively Maintained • V3 in development • Accepting Contributions
38-
39-
---
14+
> Stable • Actively Maintained • Accepting Contributions
4015
4116
## Why This Exists
4217

@@ -45,17 +20,6 @@ Most Markdown editors fall into two extremes: they’re either too minimal to be
4520
SnapDock was created to fill that gap.
4621
It provides a predictable, distraction‑free Markdown workspace for writers, developers, and creators who want clarity, speed, and a local‑first environment that stays out of the way.
4722

48-
49-
50-
## Overview
51-
SnapDock is a modern, distraction-free Markdown editor built for people who want to write without fighting their tools.
52-
53-
It focuses on clarity, stability, and local-first writing — offering a calm editing experience without plugin overload, IDE complexity, or unnecessary workflow friction.
54-
55-
SnapDock sits between minimalist note apps and heavily extensible writing platforms, providing a predictable and focused desktop writing experience that stays fast and approachable.
56-
57-
---
58-
5923
## Features
6024

6125
- Multi‑tab Markdown editing
@@ -68,11 +32,9 @@ SnapDock sits between minimalist note apps and heavily extensible writing platfo
6832
- Multiple built‑in themes
6933
- Cross‑platform desktop support
7034

71-
---
72-
7335
## Requirements
7436

75-
SnapDock runs on any modern system that supports Electron‑based desktop apps. No additional runtimes or dependencies need to be installed.
37+
SnapDock runs on any modern system that supports Electron‑based desktop apps.
7638

7739
**Operating System**
7840
- Windows 10 or later
@@ -81,57 +43,38 @@ SnapDock runs on any modern system that supports Electron‑based desktop apps.
8143
- macOS support is not currently available
8244

8345
**Hardware**
84-
- CPU: 1 core minimum (2 cores recommended)
85-
- Memory: 512 MB minimum (1 GB recommended)
86-
- Disk Space: ~750 MB
46+
- CPU: 2GHz
47+
- Memory: 2GB
48+
- Disk Space: 2GB
8749

8850
**Performance**
89-
SnapDock typically uses around **180 MB RAM** and **under 1% CPU** during normal editing, making it suitable for low‑power laptops, VMs, and older hardware.
51+
Recently snapdock has been start to slow on some builds, this is more a electron issue and im working on a fix
9052

9153
> **Note for Linux users:**
9254
> SnapDock AppImage builds require `FUSE` to run.
9355
> Some modern Linux distributions no longer ship FUSE by default.
9456
> Install it using your package manager (e.g. `sudo apt install libfuse2` on Ubuntu/Debian).
9557
96-
---
97-
9858
## Quick Start
9959

10060
Get SnapDock running from source:
10161

10262
```bash
10363
git clone https://github.com/ZFordDev/SnapDock.git
10464
cd SnapDock
105-
106-
# Install dependencies
10765
npm install
108-
109-
# Build a development build
11066
npm run build:dev
11167
```
11268

113-
### Windows
114-
- `npm install | npm run build:dev`
115-
- If npm is missing, install Node.js from [https://nodejs.org](https://nodejs.org)
116-
117-
### Linux
118-
- `npm install && npm run build:dev`
119-
- If npm is missing: `sudo apt install npm`
120-
121-
> **Note:** AppImage builds require FUSE on some distros (`sudo apt install libfuse2`).
122-
123-
---
124-
12569
## Installation
12670

12771
SnapDock is available through official stores for the easiest and most reliable installation experience.
12872

12973
### Windows (Recommended)
13074
Install SnapDock directly from the Microsoft Store:
13175

132-
~~👉 **https://apps.microsoft.com/detail/{Placeholder}**~~
76+
👉 **[Microsoft Store](https://apps.microsoft.com/store/detail/9P54JC7GWK1N?cid=DevShareMCLPCS)**
13377

134-
> Windows Store pending review
13578

13679
This provides:
13780
- Automatic updates
@@ -140,50 +83,26 @@ This provides:
14083

14184
A standalone `.exe` installer is also available on GitHub Releases if preferred.
14285

143-
### Linux (Recommended)
86+
### Linux (Broken)
14487
SnapDock is available on the Snap Store:
14588

146-
👉 **https://snapcraft.io/markdown-workspace**
89+
👉 **[Snap Store](https://snapcraft.io/markdown-workspace)**
14790

14891
Install via terminal:
14992

15093
```bash
15194
sudo snap install markdown-workspace
15295
```
15396

154-
This provides:
155-
- Automatic updates
156-
- Sandboxed, secure environment
157-
- Works across all major distros
158-
159-
### Manual Linux Packages
160-
If you prefer manual installation:
161-
162-
**AppImage**
163-
```bash
164-
chmod +x SnapDock-Setup.AppImage
165-
./SnapDock-Setup.AppImage
166-
```
167-
> If your distro blocks AppImages, install FUSE or use the `.deb` package instead.
168-
169-
**.deb Package**
170-
- Double‑click to install via your Software Center
171-
**or**
172-
```bash
173-
sudo apt install ./SnapDock-Setup.deb
174-
```
97+
> [!WARNING]
98+
> SnapStore is broken due to malformed .desktop, im activly working on a fix
17599
176100
### Other Downloads
177101
All installers and portable builds are available on GitHub Releases:
178102

179-
👉 https://github.com/ZFordDev/SnapDock/releases
180-
181-
No additional runtimes or dependencies are required.
182-
183-
---
103+
👉 [https://github.com/ZFordDev/SnapDock/releases]
184104

185105
## Project Structure
186-
*SnapDock uses a clean, modular layout. Only the high‑level structure is shown*
187106

188107
```
189108
SnapDock/
@@ -193,15 +112,11 @@ SnapDock/
193112
│ ├── modules/ # Core application logic
194113
│ │ ├── file/ # File operations, autosave, workspace, tabs
195114
│ │ ├── markdown.js # Markdown rendering pipeline
196-
│ │ ├── pdf/ # PDF export templates and logic
115+
│ │ ├── pdf/ # PDF export
197116
│ │ ├── system/ # Dirty state + update system
198-
│ │ ├── ui/ # UI logic (menus, themes, editor state)
199-
│ │ └── updater/ # In-app update system
117+
│ │ ├── ui/ # UI logic
200118
│ │
201-
│ ├── styles/ # CSS structure (base, components, themes)
202-
│ ├── preload.js # Electron preload bridge
203-
│ ├── scripts.js # Renderer scripts
204-
│ └── styles.css # Entry stylesheet
119+
│ ├── styles/ # CSS
205120
│
206121
├── index.html # Main application window
207122
├── main.js # Electron main process
@@ -271,17 +186,13 @@ https://github.com/ZFordDev/SnapDock/issues
271186
- **[Improve Build Scripts & Build‑Type Workflow](ca://s?q=Open_Build_Scripts_issue)**
272187
(#138)
273188

274-
---
275-
276189
## Screenshots
277190

278191
<p align="center">
279192
<img src="assets/screenshots/snapdock-light.png" width="45%" alt="SnapDock on Ubuntu 26 (Light Theme)" />
280193
<img src="assets/screenshots/snapdock-dark.png" width="45%" alt="SnapDock on Windows 11 (Dark Theme)" />
281194
</p>
282195

283-
---
284-
285196
## Known Issues
286197

287198
SnapDock is stable on all supported platforms, but one upstream limitation is worth noting:
@@ -291,17 +202,6 @@ Some Linux distributions may experience minor rendering or window‑manager issu
291202

292203
We continue to update Electron regularly and are evaluating alternative runtimes to maximise long‑term stability on Linux.
293204

294-
---
295-
296-
## Related Projects
297-
298-
SnapDock is part of a growing ecosystem of focused, long‑term tools.
299-
300-
- **SnapBoard** — Local‑first planning and card system
301-
https://github.com/ZFordDev/SnapBoard
302-
303-
---
304-
305205
## Support
306206

307207
You can support SnapDock by:
@@ -312,35 +212,33 @@ You can support SnapDock by:
312212
- Improving documentation
313213
- Contributing code
314214

315-
---
316-
317215
## Contributing
318216

319217
Contributions, bug reports, feature requests, and feedback are welcome.
320218

321-
See `CONTRIBUTING.md` for project‑specific guidelines.
322-
For ecosystem‑wide expectations, see [STANDARDS.md](https://github.com/ZFordDev/ZFordDev/blob/main/STANDARDS.md).
323-
324-
---
219+
See `CONTRIBUTING.md` for project‑specific guidelines.
325220

326221
## Security
327222

328223
See `SECURITY.md` for vulnerability reporting guidelines.
329-
If no security policy is present, please report issues responsibly via GitHub Issues.
330-
331-
---
332224

333225
## License
334226

335-
Released under the MIT License.
336-
See `LICENSE` for details.
337-
338-
---
227+
SnapDock is MIT and always will be!
339228

340229
## About ZFordDev
341230

342231
This project is part of the ZFordDev ecosystem — a collection of lightweight, practical tools built with clarity, simplicity, and long‑term maintainability in mind.
343232

344-
For ecosystem‑wide standards, see [STANDARDS.md](https://github.com/ZFordDev/ZFordDev/blob/main/STANDARDS.md).
345-
346233
---
234+
235+
<!-- ========================================================= -->
236+
<!-- Standards Approval Badge -->
237+
<!-- ========================================================= -->
238+
<table align="right">
239+
<tr>
240+
<td>
241+
<img src="https://raw.githubusercontent.com/ZFordDev/ZFordDev/main/assets/standards-approved.svg" width="80" alt="ZFordDev Standards Approved Badge">
242+
</td>
243+
</tr>
244+
</table>

0 commit comments

Comments
 (0)