Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rebane2001 committed Jul 12, 2023
1 parent dfddcbb commit e3b433f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 8 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Chanduino
Chanduino is a standalone unofficial 4chan browser for the ESP32 (TTGO T-Display). It started off as a project to practice embedded development and was made as a present for the /mlp/ Secret Santa, but 9 months later I decided to fix it up (added HTTPS support since 4chan is HTTPS-only now) and release it.
Chanduino is a standalone unofficial 4chan browser for the ESP32 (TTGO T-Display and T-Display-S3). It started off as a project to practice embedded development and was made as a present for the /mlp/ Secret Santa, but 9 months later I decided to fix it up (added HTTPS support since 4chan is HTTPS-only now) and release it.

## [Demo video](https://www.youtube.com/watch?v=RlFtYx4oX9U)

Expand All @@ -15,7 +15,8 @@ Chanduino is a standalone unofficial 4chan browser for the ESP32 (TTGO T-Display
- Threadwatcher (turn on screen on new posts)
- Customizable themes
- HTTPS and keep-alive support
- Progress bar
- Variable screen resolution support
- Loading bar
- Doesn't let you respond to bait
- Doesn't crash most of the time

Expand Down Expand Up @@ -52,12 +53,12 @@ You can edit the colors used in the `THEME` section of `chanduino.ino`, similar
Premade themes are available in the `themes` folder and a theme generator is available in `extra/theme_generator.html`.

# Dependencies
- [ArduinoJson 6.16.1](https://arduinojson.org/)
- [TFT_eSPI 1.4.20](https://github.com/Bodmer/TFT_eSPI)
- [ArduinoJson 6.21.2](https://arduinojson.org/)
- [TFT_eSPI 2.5.0](https://github.com/Bodmer/TFT_eSPI)
- [TJpg_Decoder](https://github.com/Bodmer/TJpg_Decoder)
- [Button2](https://github.com/LennartHennigs/Button2)
- [Button2 2.2.4](https://github.com/LennartHennigs/Button2)

You can flash this project with the Arudino IDE.

# Disclaimer
I started this project with pretty much no experience in both C++ and embedded development. Thus, the code quality and memory management is rather poor and this project should not be used as a reference for learning. You can look at it for keks though.
I started this project with pretty much no experience in both C++ and embedded development. Thus, the code quality and memory management is rather poor and this project should not be used as a reference for best practices.
16 changes: 14 additions & 2 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In order to flash chanduino to your ESP32 TTGO T-Display board, you will need a
1. Go to the menu and select Tools->Board->Boards Manager...
1. Install the esp32 module, which provides support for the "ESP32 Dev Module". Use the latest available version
1. Now go to the menu and select Tools->Manage Libraries...
1. Install the libraries (and any specifically mentioned versions!) listed under the [Dependencies section of the README](https://github.com/rebane2001/chanduino/blob/master/README.md#dependencies)
1. Install the libraries listed under the [Dependencies section of the README](https://github.com/rebane2001/chanduino/blob/master/README.md#dependencies)
1. While not always required, you may need to select the correct port under the Tools->Port menu
1. Now for the one slightly involved bit. We need to tell the TFT_eSPI library which display we have
- Open your Arduino sketchbook folder (you can find it by going to the menu File->Preferences. It will be under "Sketchbook location")
Expand All @@ -25,7 +25,7 @@ In order to flash chanduino to your ESP32 TTGO T-Display board, you will need a
//#include <User_Setup.h>
```

- Change the other line:
- (either) Change the other line (for original T-Display):

```
//#include <User_Setups/Setup25_TTGO_T_Display.h>
Expand All @@ -37,6 +37,18 @@ In order to flash chanduino to your ESP32 TTGO T-Display board, you will need a
#include <User_Setups/Setup25_TTGO_T_Display.h>
```

- (or) Change the other line (for T-Display-S3):

```
//#include <User_Setups/Setup206_LilyGo_T_Display_S3.h>
```

to:

```
#include <User_Setups/Setup206_LilyGo_T_Display_S3.h>
```

1. Great! Now we just need to open, compile and upload the chanduino code to the board.

Download the code and open the [chanduino/chanduino.ino](chanduino/chanduino.ino) file in Arduino IDE
Expand Down

0 comments on commit e3b433f

Please sign in to comment.