Code comment cleanup + README and screenshots

Author: opatry

README.md

@@ -4,23 +4,28 @@
 
 ## :scroll: Description
 
-TODO
+This app lists timers to launch at will for different needs.
+Each unit has its own indicator (for hours, minutes and seconds).
 
 ## :bulb: Motivation and Context
 
-TODO
+The main idea was to bring a really visual way to represent time, using distinct progress for each units with its own nested color circles.
+It was tough to deal with time arithmetic and smooth animation each seconds.
+
+I'm kind of satisfied by final visual even if not perfect.
+I learn a lot with this challenge #2 (Animation, backdrop (incl. conceal/reveal using `rememberCoroutineScope`), time arithmetic, canvas composable, custom font, `LazyColumn.stickyHeader`).
 
 ## :camera_flash: Screenshots
 
-## 🌞 Light Mode
-List | Details | Tablet
---- | --- | --- |
-<img src="/results/screenshot_1.png" width="260"> | <img src="/results/screenshot_2.png" width="260"> | <img src="/results/screenshot_3.png" width="520">
+### 🌞 Light Mode
+Active timer | Timers
+--- | --- |
+<img src="results/screenshot_1.png" width="260"> | <img src="results/screenshot_2.png" width="260">
 
-## 🌚 Dark Mode
-List | Details | Tablet
---- | --- | --- |
-<img src="/results/screenshot_1_dark.png" width="260"> | <img src="/results/screenshot_2_dark.png" width="260"> | <img src="/results/screenshot_3_dark.png" width="520">
+### 🌚 Dark Mode
+Active timer | Timers
+--- | --- |
+<img src="results/screenshot_1_dark.png" width="260"> | <img src="results/screenshot_2_dark.png" width="260">
 
 ## License
 ```

app/src/main/java/net/opatry/countdowntimer/CounterViewModel.kt

@@ -85,8 +85,6 @@ class CounterViewModel(private val mainDispatcher: CoroutineDispatcher = Dispatc
 
     fun start(timer: Timer) {
         viewModelScope.launch(mainDispatcher) {
-            // TODO review poor state & timers modeling
-            // keep list of timers up to date keeping last used first
             _timers.value = buildList {
                 add(timer)
                 val timers = _timers.value?.filterNot { it == timer }

app/src/main/java/net/opatry/countdowntimer/ui/component/TimerCircle.kt

@@ -65,7 +65,6 @@ fun TimerCircle(
     tickInterval: Duration,
     onFABClicked: () -> Unit
 ) {
-    // TODO animate card size when reaching 0 to make it wrapping the FAB
     Card(
         Modifier
             .padding(16.dp)

app/src/main/java/net/opatry/countdowntimer/ui/component/TimerLabel.kt

@@ -44,8 +44,6 @@ fun TimerLabel(hours: Int, minutes: Int, seconds: Int) {
     Text(
         // FIXME text "moves" because it's not a monospaced font, how could we make each "bucket" of 2-digits stable in size?
         buildAnnotatedString {
-            // TODO padded string 2 digits, pad number with alpha
-            // TODO transition anim alpha of pad number when changing from 0 to N or N to 0
             withStyle(style = SpanStyle(color = DurationUnit.HOURS.color)) {
                 append(hours.pad0())
             }

app/src/main/java/net/opatry/countdowntimer/ui/component/TimerList.kt

@@ -110,7 +110,6 @@ fun TimerListItem(timer: Timer, onTimerClicked: (Timer) -> Unit) {
 
     Text(
         buildAnnotatedString {
-            // FIXME shouldn't come from string resource for proper localization?
             if (timer.name != null) {
                 append(timer.name)
             } else {