dominic/Tactility
1
0
Fork 0
mirror of https://github.com/ByteWelder/Tactility.git synced 2026-02-18 10:53:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs (#82)

Browse Source
This commit is contained in:
Ken Van Hoeylandt 2024-11-22 23:36:48 +01:00 committed by GitHub
parent 854fefa1a1
commit a4593c6248
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
Documentation/pics/screenshot-desktop.png → Documentation/pics/screenshot-Desktop.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.3 KiB

After

Width:  |  Height:  |  Size: 4.3 KiB

0
Documentation/pics/screenshot-files.png → Documentation/pics/screenshot-Files.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 2.9 KiB

After

Width:  |  Height:  |  Size: 2.9 KiB

0
Documentation/pics/screenshot-gpio.png → Documentation/pics/screenshot-Gpio.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.3 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

BIN
Documentation/pics/screenshot-HelloWorld.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.3 KiB

0
Documentation/pics/screenshot-settings.png → Documentation/pics/screenshot-Settings.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

0
Documentation/pics/screenshot-wifi_connect.png → Documentation/pics/screenshot-WifiConnect.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 4.4 KiB

After

Width:  |  Height:  |  Size: 4.4 KiB

0
Documentation/pics/screenshot-wifi_manage.png → Documentation/pics/screenshot-WifiManage.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 3.5 KiB

12
README.md
View File

@ -9,15 +9,15 @@ It provides an application framework that is based on code from the [Flipper Zer
A modern desktop with built-in apps: A modern desktop with built-in apps:
![screenshot of desktop app](Documentation/pics/screenshot-desktop.png) ![screenshot of settings app](Documentation/pics/screenshot-settings.png) ![screenshot of desktop app](Documentation/pics/screenshot-Desktop.png) ![screenshot of settings app](Documentation/pics/screenshot-Settings.png)
Configure your Wi-Fi without having to hard-code credentials: Configure your Wi-Fi without having to hard-code credentials:
![screenshot of wifi management app](Documentation/pics/screenshot-wifi_manage.png) ![screenshot of wifi app to connect to wifi](Documentation/pics/screenshot-wifi_connect.png) ![screenshot of wifi management app](Documentation/pics/screenshot-WifiManage.png) ![screenshot of wifi app to connect to wifi](Documentation/pics/screenshot-WifiConnect.png)
And much more! And much more!
![screenshot of GPIO app](Documentation/pics/screenshot-gpio.png) ![screenshot of files app](Documentation/pics/screenshot-files.png) ![screenshot of GPIO app](Documentation/pics/screenshot-Gpio.png) ![screenshot of files app](Documentation/pics/screenshot-Files.png)
Play with the built-in apps or build your own! Use one of the supported devices or set up the drivers for your own hardware platform. Play with the built-in apps or build your own! Use one of the supported devices or set up the drivers for your own hardware platform.
@ -30,7 +30,7 @@ Noteworthy features:
Requirements: Requirements:
- ESP32 (any?) with a touchscreen - ESP32 (any?) with a touchscreen
- [esp-idf 5.2](https://docs.espressif.com/projects/esp-idf/en/v5.2/esp32/get-started/index.html) or a newer v5.2.x - [esp-idf 5.3](https://docs.espressif.com/projects/esp-idf/en/release-v5.3/esp32/get-started/index.html) or a newer v5.2.x
## Making apps is easy! ## Making apps is easy!
@ -66,7 +66,7 @@ extern const AppManifest manifest = {
}; };
``` ```
![hello world app screenshot](Documentation/pics/screenshot-helloworld.png) ![hello world app screenshot](Documentation/pics/screenshot-HelloWorld.png)
## Supported Hardware ## Supported Hardware
@ -108,7 +108,7 @@ git clone --recurse-submodules -j8 https://github.com/ByteWelder/Tactility.git
### Build environment setup ### Build environment setup
Ensure you have [esp-idf 5.3](https://docs.espressif.com/projects/esp-idf/en/release-v5.3/esp32/get-started/index.html) installed, then select the correct device: nsure you have [esp-idf 5.3](https://docs.espressif.com/projects/esp-idf/en/release-v5.3/esp32/get-started/index.html) installed, then select the correct device:
Copy the `sdkconfig.board.YOUR_BOARD` into `sdkconfig`. Use `sdkconfig.defaults` if you are setting up a custom board. Copy the `sdkconfig.board.YOUR_BOARD` into `sdkconfig`. Use `sdkconfig.defaults` if you are setting up a custom board.