Merge branch 'main' of https://github.com/acvigue/TranquilFirmware

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: acvigue

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: acvigue
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -3,11 +3,25 @@
 [![MIT License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/)
 [![CodeFactor](https://www.codefactor.io/repository/github/acvigue/tranquilfirmware/badge)](https://www.codefactor.io/repository/github/acvigue/tranquilfirmware)
 
-Firmware for the ESP32-based Tranquil kinetic sand drawing robots
+Firmware for the ESP32-based Tranquil kinetic sand drawing robots.
 
-## Debugging
+## Requirements
 
-Add `-DCORE_DEBUG_LEVEL=5` to platformio.ini and set the logging level to LOG_LEVEL_VERBOSE in main.cpp
+This is *not* a drop-in replacement for Rob Dobson's original RBotFirmware! Many things have been changed/moved around.
+
+Hardware:
+- Stepper drivers (preferably TMC2208/2209, generics can be used)
+- Endstops
+- ESP32, must have at least 4MB flash for proper OTA operation
+- SD Card - can either use MMC mode or SPI mode, SPI mode can use any pins, albeit is much slower.
+
+> This project requires an operational [TranquilAPI](https://github.com/acvigue/TranquilAPI) server! Run your own on CloudFlare Workers!
+
+## Notes
+
+The firmware is setup to automatically check for updates from a central server. The firmware binaries are built upon commit to this repository and are automatically uploaded to the OTA server.
+
+See [cloudflare-ota-server](https://github.com/acvigue/cloudflare-ota-server) for more information. 
 
 ## Robot Configuration Reference