From a4593c6248f394e891b1e02707ca33a9992ec558 Mon Sep 17 00:00:00 2001 From: Ken Van Hoeylandt Date: Fri, 22 Nov 2024 23:36:48 +0100 Subject: [PATCH] Update docs (#82) --- ...enshot-desktop.png => screenshot-Desktop.png} | Bin ...screenshot-files.png => screenshot-Files.png} | Bin .../{screenshot-gpio.png => screenshot-Gpio.png} | Bin Documentation/pics/screenshot-HelloWorld.png | Bin 0 -> 2380 bytes ...shot-settings.png => screenshot-Settings.png} | Bin ...fi_connect.png => screenshot-WifiConnect.png} | Bin ...wifi_manage.png => screenshot-WifiManage.png} | Bin README.md | 12 ++++++------ 8 files changed, 6 insertions(+), 6 deletions(-) rename Documentation/pics/{screenshot-desktop.png => screenshot-Desktop.png} (100%) rename Documentation/pics/{screenshot-files.png => screenshot-Files.png} (100%) rename Documentation/pics/{screenshot-gpio.png => screenshot-Gpio.png} (100%) create mode 100644 Documentation/pics/screenshot-HelloWorld.png rename Documentation/pics/{screenshot-settings.png => screenshot-Settings.png} (100%) rename Documentation/pics/{screenshot-wifi_connect.png => screenshot-WifiConnect.png} (100%) rename Documentation/pics/{screenshot-wifi_manage.png => screenshot-WifiManage.png} (100%) diff --git a/Documentation/pics/screenshot-desktop.png b/Documentation/pics/screenshot-Desktop.png similarity index 100% rename from Documentation/pics/screenshot-desktop.png rename to Documentation/pics/screenshot-Desktop.png diff --git a/Documentation/pics/screenshot-files.png b/Documentation/pics/screenshot-Files.png similarity index 100% rename from Documentation/pics/screenshot-files.png rename to Documentation/pics/screenshot-Files.png diff --git a/Documentation/pics/screenshot-gpio.png b/Documentation/pics/screenshot-Gpio.png similarity index 100% rename from Documentation/pics/screenshot-gpio.png rename to Documentation/pics/screenshot-Gpio.png diff --git a/Documentation/pics/screenshot-HelloWorld.png b/Documentation/pics/screenshot-HelloWorld.png new file mode 100644 index 0000000000000000000000000000000000000000..478731df7d0b46c0ba4fe65f904015007769ab50 GIT binary patch literal 2380 zcmc&$Su`667fwW4TWgzE=wd0lXoXT+Z7r=*TaBu*PmvC4ZHZtKgHcKiwN_AS-zkD3 zNo545l2}TORHC%BDiT71L^A&W%;W#?zs<`%_kQ<#xaZ#Qo_o`s9c_+CC`kYSfFriI ztX%*Apyh$j5(6FBn{0=l4uC*sd)FHWAqs^O2n1X%H#s?3L`1~I#3Usp1&_zi&dzRb zZnn3#r>3S34i1Wnio#&9g@uK;Z{L=bl%%Jp2L=WLfj~n;Ln@Vu#bRAuUB$)4aX8%E z+?;`dL1SZMeSLj#adALE0EfewpP#p}v5}ONq|s<>HoLjGxvi~jU|;}^Mu&xkF&K=s zwYAXD(20qO+}vC`o!-*YGCDe1TU#3w6N5w|$z<}_*x2;+w2_ffPEJmCcD9p~lZ%T> zRaF&NcL@olyAuR4Ox%=jo?1F*< zb93_o(oS`CwP*YG0*enV*$nRCOnl=xG;CSE{2tRzADx)dDq>dPW_Uc_`1ttXC}n15 zW@~FpBT_dH066^0*7}-jEO2c)15R}V4sW>EeD|1@@kTUd4o>D<4qHj-B(qMF{C{%B ze6zze^)=s$eLQ~A0V90L8=q=lQpdGCU!rqM{>*y(#S4|yvaaNxscXD_jrM~34{l-G^Bv8A}6 z_|*CJtMq6rcl8ucKyIYNeR#hiJooYw;V5^eO(>;LYXFO6KI`IjGX=5!OSE|^_XDk` zTkytwov+T-0;1-6)~`|JnRaF?q!0^U@4WWO6$M;Br)Fwun8Z9Rt&~VRLTwduZ(QmB z@;>g}9!b=TGR*hb-$v6hW*cPvI-W6^xi)blF}$_gjJd8~^vMRFp>M=^0Cea8qJ&Q{ z59X^6)$%VcEHBTQT861TJ2Ztn&iVu8(FhXkLJdfEcv$jzoZ{`Bu7jp~QuWq7l56Nv zcpSYIUds@NxA?SfJP?*%qg~y{)ME0ynF=Rv3zb7Dzv~hq{_MD(F2-xgu7T~gP3p&> zc$0UtWEd%&J3qkXtZdO}7W=TQrJcsorH5+;Nz(9-$y|$Bi%MzQ%QtTryKt3Z;|TcL z1zHrG!a>Vby&R2&-%WcsH}a6 z-}a`7fq>UYM6}ZdNNNY;zNqLK6$tQcnX#Wr68}SWgRkP#y3n##DV-k(^@fr_8#PQg zaj-+^p)T4FD2E2F7Z5azKi?JQj|kmy37cPiDKa`3zj~P$yI0@A##WvJ%s0Ch&SHg3 zwut77>_{VUQA6?_1p3)psUcbJ)83GT_7l;Bxw~woSS{wCrv-daqJvgMLH#?yIl;x{$&YeBDaU?bk*C) z2OI@w3!$SV`EaHw8l~x{?#2E*6%yOz79p?Gb3G9z9H+dckh{}AhqTBPd8Fm8dKJG& zZigt&%w;Q;Ly5brYB0a`FAMWhEOcEpV_phjA9T4loN9R~~L3w4`1xS@DyEHi+8L%f!XJe|Oai;C$-IY|U zM-7nmVoxJ)4g8{pOjsRSF(p<0H`03(b@NGSQ)qrVicBW<&QFAe!pY=4wM5*}KS98`9mKM+Dq4_ZJ*7tgC zakhG@xn6{xI#4iauVM@cYOcf_!I|6xxhks>&zPxa+&j$j8ePGvLp{2I^O00Nchez9 zkoL8If0+MUQH5YWinkRuXepI)ZC2x9lbiO3Gkw9XxMv9w?L~gFW5dT;dTlg9Vm43} zbp23@l$fH-Wt9NSk^dKP!XMX*AAJGqJk~}WDT}I+jRs#dTVK0$_DyBsG1jAP2y&yw v_?52^*;tMl*hl($d2&joIz4Demtv^)g>T0cl=!5Bw+LW+!_m6sx?j@Y4w`k& literal 0 HcmV?d00001 diff --git a/Documentation/pics/screenshot-settings.png b/Documentation/pics/screenshot-Settings.png similarity index 100% rename from Documentation/pics/screenshot-settings.png rename to Documentation/pics/screenshot-Settings.png diff --git a/Documentation/pics/screenshot-wifi_connect.png b/Documentation/pics/screenshot-WifiConnect.png similarity index 100% rename from Documentation/pics/screenshot-wifi_connect.png rename to Documentation/pics/screenshot-WifiConnect.png diff --git a/Documentation/pics/screenshot-wifi_manage.png b/Documentation/pics/screenshot-WifiManage.png similarity index 100% rename from Documentation/pics/screenshot-wifi_manage.png rename to Documentation/pics/screenshot-WifiManage.png diff --git a/README.md b/README.md index 600a1102..adfe77b8 100644 --- a/README.md +++ b/README.md @@ -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: -![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: -![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! -![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. @@ -30,7 +30,7 @@ Noteworthy features: Requirements: - 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! @@ -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 @@ -108,7 +108,7 @@ git clone --recurse-submodules -j8 https://github.com/ByteWelder/Tactility.git ### 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.