Ver Fonte

Cleaned up docs, added roadmap items

arianagiroux há 3 semanas atrás
pai
commit
179b87540c
3 ficheiros alterados com 37 adições e 21 exclusões
  1. 34 5
      Readme.md
  2. 3 0
      main.go
  3. 0 16
      resources

+ 34 - 5
Readme.md

@@ -2,13 +2,42 @@
 
 to run the project, simply `go run .`
 
+to install the project, simply `go install .`
+
+additionally, see `bin/` for additional pre-compiled binaries
+
 ## TODO:
 
-### Core
- - [x] Implement Bubbletea framework
- - [x] Implement lipgloss styling
- - [ ] Implement viewport logic via bubbles
- - [x] Implement ntcharts framework for tables
+- main.go:// TODO(main): set chart height by user flag
+- main.go:// TODO(main): determine chart heights dynamically by number of addresses
+
+# Core
+ - [x] Implements Bubbletea framework
+ - [x] Implements lipgloss styling
+ - [x] Implements viewport logic via bubbles
+ - [x] Implements ntcharts framework for tables
 
 ### Extras
  - [ ] Implement ssh TUI client (via wish)
+
+| resource        | use                                |
+|-----------------|------------------------------------|
+| Core frameworks |                                    |
+| [bubbletea][bt] | TUI framework                      |
+| [lipgloss][lg]  | Terminal text formatting framework |
+|-----------------|------------------------------------|
+| TUI widgets     |                                    |
+| [bubbles][bbl]  | widget lib for bubbletea           |
+| [ntcharts][ntc] | chart widgets for bubbletea        |
+|-----------------|------------------------------------|
+| extras          |                                    |
+| [wish][wish]    | ssh tui client                     |
+|-----------------|------------------------------------|
+
+[bt]: https://github.com/charmbracelet/bubbletea
+[lg]: https://github.com/charmbracelet/lipgloss
+[bbl]: https://github.com/charmbracelet/bubbles
+[ntc]: https://github.com/NimbleMarkets/ntcharts
+[wish]: https://github.com/charmbracelet/wish
+
+[](vim: nowrap)

+ 3 - 0
main.go

@@ -1,3 +1,6 @@
+// TODO(main): set chart height by user flag
+// TODO(main): determine chart heights dynamically by number of addresses
+
 package main
 
 import (

+ 0 - 16
resources

@@ -1,16 +0,0 @@
-|--------------------+--------------------------------------------+----------------------------------------|
-| name               | url                                        | use                                    |
-|--------------------+--------------------------------------------+----------------------------------------|
-| Core frameworks    |                                            |                                        |
-| bubbletea          | https://github.com/charmbracelet/bubbletea | TUI framework                          |
-| lipgloss           | https://github.com/charmbracelet/lipgloss  | Terminal text formatting framework     |
-|--------------------+--------------------------------------------+----------------------------------------|
-| TUI widget modules |                                            |                                        |
-| bubbles            | https://github.com/charmbracelet/bubbles   | widget lib for bubble tea framework    |
-| ntcharts           | https://github.com/NimbleMarkets/ntcharts  | chart widgets for bubble tea framework |
-|--------------------+--------------------------------------------+----------------------------------------|
-| extras             |                                            |                                        |
-| wish               | https://github.com/charmbracelet/wish      | ssh TUI clients                        |
-|--------------------+--------------------------------------------+----------------------------------------|
-
--- vim: nowrap