Druk-3D/prind
1
0
Fork 0
mirror of https://github.com/mkuf/prind.git synced 2025-10-31 10:26:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix code blocks in readme

Browse Source
This commit is contained in:
Markus Küffner
2024-03-01 19:15:51 +01:00
parent 6546543b35
commit 6e32bc0671
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -18,7 +18,7 @@ Currently supported Frontends:
Depending on which Frontend you've chosen, moonraker will also be deployed. Depending on which Frontend you've chosen, moonraker will also be deployed.
## Getting started ## Getting started
The following Guide requires `docker`` and ``docker compose` on your machine. The following Guide requires `docker` and `docker compose` on your machine.
Follow the official Guides on how to get them up and running. Follow the official Guides on how to get them up and running.
* https://docs.docker.com/engine/install/ubuntu/ * https://docs.docker.com/engine/install/ubuntu/
* https://docs.docker.com/compose/cli-command/#installing-compose-v2 * https://docs.docker.com/compose/cli-command/#installing-compose-v2
@@ -39,7 +39,7 @@ make flash FLASH_DEVICE=/dev/serial/by-id/<my printer>
If your Board can be flashed via SD-Card, you may want to omit `make flash` and retrieve the `klipper.bin` from the `out` directory that is created by `make`. Follow your boards instructions on how to proceed with flashing via SD-Card. If your Board can be flashed via SD-Card, you may want to omit `make flash` and retrieve the `klipper.bin` from the `out` directory that is created by `make`. Follow your boards instructions on how to proceed with flashing via SD-Card.
### Add your Configuration to docker-compose.override.yaml ### Add your Configuration to docker-compose.override.yaml
Locate the `webcam`` Service within ``docker-compose.override.yaml`` and update the ``device` Section with the Device Name of your Webcam. Locate the `webcam` Service within `docker-compose.override.yaml` and update the `device` Section with the Device Name of your Webcam.
In this example, the Webcam is using device `/dev/video0`. Do not edit any other lines. In this example, the Webcam is using device `/dev/video0`. Do not edit any other lines.
```yaml ```yaml
webcam: webcam:
@@ -58,7 +58,7 @@ In this example, the Webcam is using device `/dev/video0`. Do not edit any other
### Configuring Klipper/Moonraker ### Configuring Klipper/Moonraker
All Runtime Configs are stored within `config` of this Repo. All Runtime Configs are stored within `config` of this Repo.
* Update `config/printer.cfg` with your Klipper config, set the serial device and make sure to not remove the existing Macros as they are required by fluidd/mainsail. See [Klipper3d Docs](https://www.klipper3d.org/Config_Reference.html) for Reference * Update `config/printer.cfg` with your Klipper config, set the serial device and make sure to not remove the existing Macros as they are required by fluidd/mainsail. See [Klipper3d Docs](https://www.klipper3d.org/Config_Reference.html) for Reference
* Make sure to update `cors_domains`` and ``trusted_clients`` within ``moonraker.cfg` to secure your moonraker api from unwanted access. See [Moonraker Docs](https://moonraker.readthedocs.io/en/latest/configuration/) for Reference * Make sure to update `cors_domains` and `trusted_clients` within `moonraker.cfg` to secure your moonraker api from unwanted access. See [Moonraker Docs](https://moonraker.readthedocs.io/en/latest/configuration/) for Reference
### Starting the stack ### Starting the stack
There are currently 3 frontend Profiles to choose from, depending on the Web Frontend you'd like to use. There are currently 3 frontend Profiles to choose from, depending on the Web Frontend you'd like to use.
@@ -292,10 +292,10 @@ Hence replace webcam2 with webcam3 and so on for every webcam you add and update
### Building Docker images locally ### Building Docker images locally
If you'd like to customize the provided Docker Images, you may edit the Dockerfiles within the `docker/<service>` Directory. If you'd like to customize the provided Docker Images, you may edit the Dockerfiles within the `docker/<service>` Directory.
Images are build in multiple stages, the final stage is called `run``. Based on this, you can update Service definitions within ``docker-compose.override.yaml` to build Images locally. Images are build in multiple stages, the final stage is called `run`. Based on this, you can update Service definitions within `docker-compose.override.yaml` to build Images locally.
Example: Build Moonraker Example: Build Moonraker
Update the `image:`` name and add a ``build` config: Update the `image:` name and add a `build` config:
```yaml ```yaml
moonraker: moonraker:
image: moonraker:latest image: moonraker:latest