Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ See [User Documentation](https://snapmakeru1-extended-firmware.pages.dev/) for f

## Building from Source

**Source repositories:**
- GitHub: [https://github.com/paxx12](https://github.com/paxx12)
- Codeberg: [https://codeberg.org/paxx12-snapmaker-u1](https://codeberg.org/paxx12-snapmaker-u1)

See [Building from Source](docs/development.md) for instructions on building custom firmware using Docker.

## Dependent projects
Expand Down
17 changes: 17 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ For external third-party components, see [Third-Party Integrations](design/third

The `./dev.sh` script automatically sets up a Debian Trixie ARM64 environment with all required dependencies.

## Source Repository

The project is hosted on GitHub with a mirror on Codeberg:

- **GitHub**: [https://github.com/paxx12](https://github.com/paxx12)
- **Codeberg**: [https://codeberg.org/paxx12-snapmaker-u1](https://codeberg.org/paxx12-snapmaker-u1)

### Using Codeberg Mirror

To use Codeberg as the source instead of GitHub, configure git to automatically remap GitHub URLs:

```bash
git config --global url."https://codeberg.org/paxx12-snapmaker-u1/".insteadOf "https://github.com/paxx12/"
```

This remaps all GitHub repository URLs to Codeberg automatically, including submodules and dependencies.

## Quick Start

Build tools and download firmware:
Expand Down
1 change: 1 addition & 0 deletions docs/firmware_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Toggle settings directly from the web interface:
| Klipper Metrics Exporter | Enabled, Disabled | Enable Prometheus metrics |
| VPN Provider | None, Tailscale | Enable VPN remote access (Experimental) |
| Cloud | None, OctoEverywhere | Enable Cloud-based remote access (Experimental) |
| Tweaks | TMC AutoTune, TMC Reduced Current, Object Processing, AFC Stub | Experimental Klipper tweaks ([tweaks](tweaks.md)) |

Changes are applied immediately and relevant services are restarted.

Expand Down
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ Download the latest firmware from [Releases](https://github.com/paxx12/Snapmaker

### Building from Source

**Source repositories:**
- GitHub: [https://github.com/paxx12](https://github.com/paxx12)
- Codeberg: [https://codeberg.org/paxx12-snapmaker-u1](https://codeberg.org/paxx12-snapmaker-u1)

For developers who want to build custom firmware, see [Building from Source](development.md).

## Community
Expand All @@ -52,7 +56,7 @@ Heavily expanded firmware with extensive features and customization. Includes al
- [Firmware Configuration](firmware_config.md) - Customize firmware behavior via web interface or config file
- [Camera Support](camera_support.md) - Hardware-accelerated camera stack with WebRTC streaming for internal and USB cameras
- [Klipper and Moonraker Custom Includes](klipper_includes.md) - Add custom configuration files via Fluidd/Mainsail
- [Klipper Tweaks](tweaks.md) - Experimental TMC driver optimizations and [object processing for adaptive mesh](tweaks.md#object-processing-for-adaptive-mesh) (firmware-config only)
- [Klipper Tweaks](tweaks.md) - Experimental [TMC driver optimizations](tweaks.md#tmc-autotune), [reduced current](tweaks.md#tmc-reduced-current), and [object processing for adaptive mesh](tweaks.md#object-processing-for-adaptive-mesh) (firmware-config only)
- [AFC-Lite Stub](afc-lite.md) - Experimental AFC UI compatibility layer for Fluidd/Mainsail (may be removed)
- [RFID Filament Tag Support](rfid_support.md) - NTAG213/215/216 support for OpenSpool format
- [Remote Screen](remote_screen.md) - View and control printer screen remotely via web browser
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@
:root { --bg: #1a1a1a; --card: #2d2d2d; --item: #3d3d3d; --hover: #4d4d4d; --accent: #4fc3f7; --text: #e0e0e0; --muted: #888; --success: #81c784; --error: #e57373; --warning: #ff9800; }
* { margin: 0; padding: 0; box-sizing: border-box; }
body { font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif; background: var(--bg); color: var(--text); min-height: 100vh; padding: 20px; }
a { color: var(--accent); text-decoration: none; }
a:hover { text-decoration: underline; }
.container { max-width: 900px; margin: 0 auto; }
h1 { color: var(--accent); margin-bottom: 20px; font-size: 24px; display: flex; justify-content: space-between; align-items: center; }
.card { background: var(--card); border-radius: 8px; padding: 16px; margin-bottom: 16px; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ settings:
label: Tweaks
items:
object_processing:
label: Object Processing for Adaptive Mesh
label: 'Object Processing for Adaptive Mesh (<a href="http://snapmakeru1-extended-firmware.pages.dev/tweaks#object-processing-for-adaptive-mesh" target="_blank">link</a>)'
get_cmd:
- bash
- -c
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ settings:
label: Tweaks
items:
tmc_autotune:
label: TMC AutoTune
label: 'TMC AutoTune (<a href="http://snapmakeru1-extended-firmware.pages.dev/tweaks#tmc-autotune" target="_blank">link</a>)'
get_cmd:
- bash
- -c
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ settings:
label: Tweaks
items:
tmc_reduce_current:
label: TMC Reduced Current
label: 'TMC Reduced Current (<a href="http://snapmakeru1-extended-firmware.pages.dev/tweaks#tmc-reduced-current" target="_blank">link</a>)'
get_cmd:
- bash
- -c
Expand Down
Loading