Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modified and rearanged documentation files #104

Merged
merged 1 commit into from
Nov 25, 2024

Conversation

Martinius79
Copy link
Collaborator

  • Modified the root README.MD file heavily
  • Added images to be used in the README.MD file
  • Created new subfolder "documentation"
  • Moved and renamed hardware description folders and other stuff to the documentation folder
  • Changed location for images in the MD to the ImagesMD folder in the documentation folder
  • Modified README.MD in the pre-build-images subfolder
  • Added photos of Elekstube IPS Gen1 and Gen2 and PunkCyber IPS
  • Removed hardware modification folder -> Was just one image inside. Moved infos to the end of the README.MD.
  • Renamed some existing files in the PunkCyber folder
  • Modified _USER_DEFINES - empty - modified the structure of the MQTT section and added inline comments.
  • fixed a typo in the TO-DO.txt

Modified the main MD file for more clarity. Added sections, added images, added section numbers, added MQTT section, added Firmware file build explaination, moved sections or modified them.

Modified the MD file in the pre-build-images folder. Added information about the GitHub workflow builds, formated the list of the files as table, modified the feature list.

This is the "Non IPSTUBE" version, just for the existing variants so far.

… subfolder "documentation" - Changed location for images in the MD - Moved hardware description folders and other to the documentation folder - Modified README.MD in the pre-build-images subfolder - Added photos of Elekstube IPS Gen1 and Gen2 and PunkCyber IPS
@aly-fly aly-fly merged commit f40381b into aly-fly:main Nov 25, 2024
2 checks passed
@Martinius79 Martinius79 deleted the UpdatedDocumentation branch November 28, 2024 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants