From aa4a2daf5687ea512e2f5b8e7151262b6887121b Mon Sep 17 00:00:00 2001 From: "Markus F.J. Busche" Date: Sat, 20 Sep 2025 13:38:35 +0200 Subject: [PATCH] Move README.md to root directory and update documentation links --- .../README.md => README.md | 2 +- octoprint_tailscale_funnel/BUILDING.md | 23 ++++++++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) rename octoprint_tailscale_funnel/README.md => README.md (95%) diff --git a/octoprint_tailscale_funnel/README.md b/README.md similarity index 95% rename from octoprint_tailscale_funnel/README.md rename to README.md index 06e44a1..b20586d 100644 --- a/octoprint_tailscale_funnel/README.md +++ b/README.md @@ -24,7 +24,7 @@ This plugin makes your OctoPrint instance accessible from anywhere via Tailscale ## Building from Source -If you want to build the plugin from source, please refer to the [BUILDING.md](BUILDING.md) file for detailed instructions. +If you want to build the plugin from source, please refer to the [BUILDING.md](octoprint_tailscale_funnel/BUILDING.md) file for detailed instructions. ## Configuration diff --git a/octoprint_tailscale_funnel/BUILDING.md b/octoprint_tailscale_funnel/BUILDING.md index 0b37185..920f657 100644 --- a/octoprint_tailscale_funnel/BUILDING.md +++ b/octoprint_tailscale_funnel/BUILDING.md @@ -122,4 +122,25 @@ The plugin version is defined in `setup.py`. To release a new version: * [OctoPrint Plugin Development Documentation](https://docs.octoprint.org/en/master/plugins/getting-started.html) * [Tailscale Documentation](https://tailscale.com/kb/) -* [Python Packaging Documentation](https://packaging.python.org/) \ No newline at end of file +* [Python Packaging Documentation](https://packaging.python.org/) + +## Project Structure + +The project follows a standard structure: + +``` +. +├── README.md # Project overview and usage instructions +├── .gitignore # Files and directories to exclude from Git +├── octoprint_tailscale_funnel/ # Plugin source code +│ ├── BUILDING.md # This document +│ ├── setup.py # Plugin setup and metadata +│ ├── __init__.py # Main plugin implementation +│ ├── tailscale_interface.py # Tailscale command interface +│ ├── status_monitor.py # Status monitoring functionality +│ ├── requirements.txt # Python dependencies +│ ├── MANIFEST.in # Files to include in distribution +│ ├── static/ # Static assets (CSS, JS) +│ ├── templates/ # HTML templates +│ └── tests/ # Unit tests +``` \ No newline at end of file