Skip to content

Commit

Permalink
Update README with credits and flashing hints
Browse files Browse the repository at this point in the history
After finding out some flashing quirks, I put them into the readme. Also linked our usernames.
  • Loading branch information
TokenRat committed Sep 5, 2024
1 parent e5adcf6 commit c01902d
Showing 1 changed file with 13 additions and 26 deletions.
39 changes: 13 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,14 @@ You can archive most things with the `pio` command from PlatformIO.
* Clean generated files: `pio run --target clean`
* Attach serial monitor: `pio device monitor`

**Note:**

If you encounter issues flashing via USB, try the following:

* Some USB cables or ports are flaky. Try a different USB port or change the USB-C -> USB-C cable to a USB-A -> USB-C or vice versa.
* Make sure no program is opening the serial port while you flash. For example serial monitors in auto-connect mode.
* If it still fails, bridge the boot-pins when turning on. The badge should load into a simple bootloader and wait.


## Component Overview

Expand Down Expand Up @@ -177,33 +185,12 @@ For convenience, here is an exported PDF version of the schematics:
[![Screenshot: Schematics thumbnail](docs/assets/efbadge-schematic_thumb.png)](hardware/efbadge-schematic.pdf)


# Useful links

* ESP32-S3 Pin-out and functions: https://github.com/atomic14/esp32-s3-pinouts

# Credits

This badge was designed, crafted and programmed with much love and dedication
by: DarkRat, Token, Irah, Honigeintopf. The wonderful artwork is done by
by: [DarkRat](https://github.com/dunkelratte), [Token](https://github.com/TokenRat), [Irah](https://github.com/tridekdu), [Honigeintopf](https://github.com/ngandrass). The wonderful artwork is done by
[Fleeks](https://www.furaffinity.net/user/fleeks).


# License

MIT License

Copyright 2024 Eurofurence e.V.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the “Software”),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.

0 comments on commit c01902d

Please sign in to comment.