Add Makefile and Markdown linter (#73)

* Add Makefile

* Update .gitignore to exclude venv

* Add requirements.txt for venv

* Add pymarkdown lint Github action

* Update .md from lint tool

* Update README with make commands

* Add linter config
This commit is contained in:
Adriaan Van Niekerk
2025-10-31 01:06:36 +02:00
committed by GitHub
parent bbe3bd79db
commit 0cd98c67e2
44 changed files with 524 additions and 279 deletions

View File

@@ -1,26 +1,25 @@
# Alignment References
The alignment references are used in every round to re-align the taken image to the reference coordinates.
The alignment references are used in every round to re-align the taken image to the reference coordinates.
Two alignment structures must be defined and the taken image then in each round is shifted and rotated according to their position
with the target to be in exactly the same position as the reference image.
!!! Note
The alignment structures needs to be unique and have a good contrast.
The alignment structures needs to be unique and have a good contrast.
It is advised to have them as far apart as possible.
## Precondition
Please make sure to have setup your camera properly and taken a good [Reference Image](Reference-Image.md).
## Define two Reference Images
![](img/initial_setup_2_alignment_marks.jpg){: style="width:500px"}
![Initial Setup Alignment Marks](img/initial_setup_2_alignment_marks.jpg){: style="width:500px"}
You can switch between this two marks with `(1)`.
Then define the reference area in the image by either directly drag and drop with the mouse or use the input boxes below.
To apply the currently marked image part you need to push `"Update Reference" (2)`.
To apply the currently marked image part you need to push `"Update Reference" (2)`.
In some cases it might be useful to use a reference with a higher contrast. This can be achieved by pushing `Enhance Contrast" (3)`.
The result will be calculated on the ESP32 - so be a bit patient, before you see it active.