Skip to content

Commit 50ff3cc

Browse files
committed
Add Overview for esp3d.io integration
1 parent 4903fd4 commit 50ff3cc

6 files changed

Lines changed: 146 additions & 12 deletions

File tree

docs/TODO.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,21 @@
22

33
Known items and ideas for future work. No priority order.
44

5-
## Translations
6-
7-
- Fill in `.po` files for: Italian, Spanish, German, Dutch, Traditional Chinese (zh_TW),
8-
Simplified Chinese (zh_CN), Japanese
9-
- French catalog still has ~150 untranslated strings
10-
- Compile `.mo` files and test layout (especially CJK line wrapping)
11-
12-
## Packaging
13-
14-
- AppImage packaging (optional, tracked in `docs/PACKAGING.md`)
15-
165
## Discovery
176

187
- SFTP service detection via mDNS (`_sftp-ssh._tcp`)
198
- Optional WSD multicast interface selection (multi-homed hosts)
20-
- NetBIOS: improve when `nmblookup` is not installed (show a hint in UI)
9+
- NetBIOS: show a hint in the UI when `nmblookup` is not installed
10+
- **Performance** — cache pre-population at startup (emit cached SSDP devices before
11+
live discovery completes, so the window is populated in < 100 ms)
12+
- **Performance** — NetBIOS directed probes: run in parallel with `ThreadPoolExecutor`
13+
instead of sequential `nmblookup -A` calls (see `docs/MAINTENANCE.md`)
14+
- **Performance** — SSDP XML fetches: per-host lock instead of single global lock
15+
(allows concurrent descriptor fetches at startup)
16+
- **Performance** — wsdd_client: remove hardcoded 0.35 s sleep between probe and list
2117

2218
## UI
19+
2320
- Context menu "Open" submenu: keyboard navigation improvement
2421
- Per-device command label shown in tooltip when hovering a device tile
2522
- Notifications history: persist across sessions (currently session-only)
331 KB
Loading

docs/esp3d-overview/index.mdx

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
---
2+
title: NetNeighbor
3+
description: Discover and monitor devices on your local network — a free Linux desktop application.
4+
---
5+
6+
import { Card, CardGrid, LinkButton, Badge } from '@astrojs/starlight/components';
7+
8+
**Discover and monitor devices on your local network.**
9+
10+
NetNeighbor is a free Linux desktop application that automatically finds all devices
11+
on your network and displays them with icons or in a list — printers, NAS drives,
12+
cameras, routers, 3D printers, and more.
13+
14+
![NetNeighbor main window](./overview-hero.png)
15+
16+
---
17+
18+
## Features
19+
20+
<CardGrid>
21+
<Card title="Instant display" icon="rocket">
22+
Previously-seen devices appear immediately at startup from the local cache — no
23+
waiting for discovery to complete.
24+
</Card>
25+
<Card title="Automatic discovery" icon="magnifier">
26+
Finds devices without any configuration or active port scan (SSDP, mDNS,
27+
WS-Discovery, NetBIOS).
28+
</Card>
29+
<Card title="One-click connection" icon="external">
30+
Opens HTTP, HTTPS, SMB, SSH, FTP, SFTP and Telnet with a double-click.
31+
Configurable per device and per scheme.
32+
</Card>
33+
<Card title="Device management" icon="setting">
34+
Rename devices, tag by location, assign a custom icon or type. Settings are
35+
stored locally and survive reboots.
36+
</Card>
37+
<Card title="System tray" icon="laptop">
38+
Runs quietly in the background. Optional autostart at login and minimize to tray.
39+
</Card>
40+
<Card title="Localised" icon="translate">
41+
French, Spanish, German, Italian, Dutch, Japanese, Simplified and Traditional
42+
Chinese.
43+
</Card>
44+
</CardGrid>
45+
46+
---
47+
48+
## Screenshots
49+
50+
### Device list with sidebar
51+
52+
![Device list with sidebar](./main-list.png)
53+
54+
The sidebar groups devices by type or location. Switch between icon grid and list view
55+
from the View menu.
56+
57+
### Right-click menu
58+
59+
![Right-click context menu](./context-menu.png)
60+
61+
Right-click any device to open it, view its details, rename it, change its type,
62+
assign a location, or run a custom command.
63+
64+
### System tray
65+
66+
![System tray menu](./tray-menu.png)
67+
68+
NetNeighbor can minimise to the system tray and start silently at login.
69+
70+
---
71+
72+
## Download
73+
74+
<Badge text="Latest release: 1.0.0" variant="success" />
75+
76+
<CardGrid>
77+
<Card title=".deb package" icon="linux">
78+
**Recommended** for Ubuntu, Linux Mint, and Debian.
79+
Dependencies installed automatically.
80+
81+
```bash
82+
sudo dpkg -i netneighbor_1.0.0_amd64.deb
83+
```
84+
</Card>
85+
<Card title="AppImage" icon="puzzle">
86+
Runs on any Linux distribution.
87+
Requires Python 3 and GTK 3 on the system.
88+
89+
```bash
90+
chmod +x NetNeighbor-1.0.0-x86_64.AppImage
91+
./NetNeighbor-1.0.0-x86_64.AppImage
92+
```
93+
</Card>
94+
</CardGrid>
95+
96+
<LinkButton href="https://github.com/luc-github/NetNeighbor/releases/latest" icon="github" variant="primary">
97+
Download from GitHub Releases
98+
</LinkButton>
99+
<LinkButton href="https://github.com/luc-github/NetNeighbor/releases" icon="list-format" variant="minimal">
100+
All releases and checksums
101+
</LinkButton>
102+
103+
---
104+
105+
## Requirements
106+
107+
- Linux desktop (Ubuntu 22.04+, Linux Mint 21+, Debian 12+, or equivalent)
108+
- Python 3.10 or later · GTK 3
109+
110+
For **NetBIOS name resolution** (Windows device names):
111+
```bash
112+
sudo apt install samba-common-bin
113+
```
114+
115+
For the **system tray icon**:
116+
```bash
117+
sudo apt install gir1.2-ayatanaappindicator3-0.1
118+
```
119+
120+
Both are included automatically when installing the `.deb` package.
121+
122+
---
123+
124+
## Documentation
125+
126+
<CardGrid>
127+
<Card title="User documentation" icon="open-book">
128+
Detailed guide covering all features, dialogs, preferences, and troubleshooting.
129+
130+
[Read USER_DOCUMENTATION →](https://github.com/luc-github/NetNeighbor/blob/main/USER_DOCUMENTATION.md)
131+
</Card>
132+
<Card title="Source code" icon="github">
133+
MIT-licensed, contributions welcome.
134+
135+
[github.com/luc-github/NetNeighbor →](https://github.com/luc-github/NetNeighbor)
136+
</Card>
137+
</CardGrid>

docs/esp3d-overview/main-list.png

71.5 KB
Loading
193 KB
Loading

docs/esp3d-overview/tray-menu.png

159 KB
Loading

0 commit comments

Comments
 (0)