From 70097422f2b1713ba5d23e1f3eaf252f837d1936 Mon Sep 17 00:00:00 2001
From: alexcoder04 <alexcoder04@protonmail.com>
Date: Thu, 6 Oct 2022 22:17:03 +0200
Subject: [PATCH] update todos

---
 README.md | 54 ++++++++++++++++++++++++++++++------------------------
 1 file changed, 30 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index 6262dd2..b61dd77 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,16 @@
 
 # Sol
 
-GUI application framework for the TI-nspire.
+GUI application framework for the TI-nspire. This repository is the "home" of the project
+and contains all the Lua library code.
+
+[Here](https://alexcoder04.github.io/sol-docs/) you can find the docs.
 
 [Here](https://github.com/alexcoder04/sol-helloworld) you can find an example application.
 
 [These](https://github.com/alexcoder04/sol-tools) are the tools needed for developing applications with Sol.
 
-[Here](https://alexcoder04.github.io/sol-docs/) you can find the docs.
-
-## Why
+## Why?
 
 Building GUI applications for TI-nspire using the stock Lua library from TI
 is a pain, this is an attempt to make it easier and more comfortable.
@@ -17,44 +18,49 @@ is a pain, this is an attempt to make it easier and more comfortable.
 ## Your project structure
 
 Your code has to be organized, no "throwing everything into one Lua file" anymore!
-All the parts are then assembled and built into one `.tns` file by Sol.
+All the parts are then assembled and built into one `.tns` file by [sol-tools](https://github.com/alexcoder04/sol-tools).
 
  - `res` contains any non-code resources, e. g. images and data.
  - `res/data/menu.yml` is a native nspireOS-menu, written in YAML
- - `components` are re-usable blocks of your GUI which can inherit from base components, written in a custom YAML-based language
+ - `components` are re-usable blocks of your GUI which can inherit from base components, written in YAML
  - `init.lua` runs at start
- - `app.lua` is just metadata
- - `layout.lua` defines which components are included and in which order
+ - `app.lua` is your main file where you define what is your application about
 
 ```text
  |
- |-res
- | |-img
- | | |-...
- | |-data
- | | |-menu.yml
- | | |-...
- |-components
- | |-header.yml
- | |-text.yml
- | |-...
- |-init.lua
- |-app.lua
- |-layout.lua
+ |--res
+ |  |--img
+ |  |  |--...
+ |  |--data
+ |  |  |--menu.yml
+ |  |  |--...
+ |--components
+ |  |--header.yml
+ |  |--text.yml
+ |  |--...
+ |--init.lua
+ |--app.lua
 ```
 
 ## Roadmap / TODOs
 
- - [ ] more base components (input field, list, sublayouts, tabs)
+ - [ ] more base components
+   - [ ] input field
+   - [ ] list
+   - [ ] sublayouts
+   - [ ] tabs
+   - [ ] console
+   - [ ] game canvas using physics api
+   - [ ] 2D-editor using nspire's built-in editor
  - [x] colorful components
  - [x] click events
  - [ ] component focus (tabbing, highlighting selected)
  - [x] menu api
  - [x] paint hook, use raw `gc` functions
  - [x] persistent data storage
- - [ ] game canvas component using nspire physics api
  - [ ] message box components imitating nspireOS's UI
- - [ ] 2D-editor component using nspire's built-in editor
+ - [ ] redraw on timer only if one of update functions returns true
+ - [ ] rename `Library` to `Lib`
 
 ## Naming