Merge pull request #12 from jaswch/main

Update platformio.ini and README.md

Author: jaswch

README.md

@@ -21,10 +21,10 @@ When we look at the current smart watches (especially the cheap ones) the are pr
 5. Connect the Stemma qt connector to the TQT Pro
 
 # Installation (for platformio users)
-Create a new project and paste all of the files in your project's directory and upload the code (Note:- You may need to change the build flags in ```platformio.ini``` if using an 8MB version of TQT Pro)
+Clone the repository and upload the code (Note:-If using an 8MB version of TQT Pro uncomment line 10 and comment line 11 and 17 in ```platformio.ini``` file)
 
 # Installation (for arduino users)
-All of the required code is in the ```src``` directory, just rename the file ```main.cpp``` to ```main.ino``` and install ```Button2``` and ```TFT_eSPI``` (according to LILYGO TFT_eSPI version 2.0.14 or lower is recommended) in the ide and upload the code 
+All of the required code is in the ```src``` directory, just rename the file ```main.cpp``` to ```main.ino``` and install ```Button2```, ```TFT_eSPI``` (according to LILYGO TFT_eSPI version 2.0.14 or lower is recommended), ```Adafruit GFX```, ```Adafruit MPU6050``` and ```Adafruit Unified Sensor``` in the ide and upload the code 
 
 # Features
 1. Home screen with custom background
@@ -47,7 +47,7 @@ All of the required code is in the ```src``` directory, just rename the file ```
 4. While playing pong scroll button moves the paddle up and the menu button moves the paddle down
 
 # Release Notes
-1. **V0.3** - New UI, multiple watch faces, Wifi support, time synchronisation, back option in menus, accelerometer support and apps and sub menus sepereted from the ```main.cpp``` file.
+1. **V0.3** - New UI (created using [lopaka.app](https://lopaka.app/sandbox)), multiple watch faces, Wifi support, time synchronisation, back option in menus, accelerometer support and apps and sub menus sepereted from the ```main.cpp``` file.
 2. **V0.2.1** - Added refinements to the OS navigation, added a manual in the ```README.md``` and changed the tone of the speaker.
 3. **V0.2** - A significant update compared to V0.1, as it introduced menus, pong, interaction with peripherals (torch and speaker), OS being open sourced, matrix effect, settings menu. 
 4. **V0.1** - The initial release it just had a home screen and an about screen.
@@ -59,10 +59,9 @@ By V0.7 or V0.8 we could start making SDKs for developers to make apps and games
 Yes, you can contribute to the project by the following ways :
 1. Help us add features to the project by making a PR.
 2. Help us test and find bugs.
-3. Give feature suggestions by making an issue.
+3. Give feature suggestions in this [issue](https://github.com/OpenTimeWatch-Project/OpenTimeWatch-OS/issues/1).
 4. Help us test or review PRs.
-5. Leave a star ✨ if you like the project.
-6. PS : If you have a better logo for the project please let us know by opening a new issue (don't worry we will credit you)
+5. PS : If you have a better logo for the project please let us know by opening a new issue (don't worry we will credit you)
 
 # Images
 ![Alt text](images/IMG_20241119_201516.jpg)

platformio.ini

@@ -1,23 +1,19 @@
 ; PlatformIO Project Configuration File
-;
-;   Build options: build flags, source filter
-;   Upload options: custom upload port, speed and extra flags
-;   Library options: dependencies, extra library storages
-;   Advanced options: extra scripting
-;
-; Please visit documentation for the other options and examples
-; https://docs.platformio.org/page/projectconf.html
+
 
 [platformio]
 boards_dir = ./board
 default_envs = T-QT-Pro-N4R2
-description = Open source watch OS
+description = Open source watch OS for ESP32 based watches
 
+; uncomment the below line if you have 8mb of flash and no PSRAM and comment the line below it
+;[env:T-QT-Pro-N8]
 [env:T-QT-Pro-N4R2]
 platform = espressif32@6.6.0
 board = esp32-s3-t-qt-pro
 framework = arduino
 build_flags = 
+    ; comment the below line if you don't have PSRAM
 	-DBOARD_HAS_PSRAM
 lib_deps = 
 	lennarthennigs/Button2@^2.3.3