Move README.md to root directory and update documentation links
This commit is contained in:
@@ -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
|
||||
|
@@ -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/)
|
||||
* [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
|
||||
```
|
Reference in New Issue
Block a user