a/SD
Archived
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add more usage instructions

Browse source
This commit is contained in:
Anthony Wang 2022-03-31 12:17:33 -05:00
parent 205e55ff65
commit d39bb36216
Signed by: a
GPG key ID: BC96B00AEC5F2D76
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -6,12 +6,12 @@ Very efficient flash cards app using Go and SQLite
Flash cards are stored in the `cards` table of a SQLite database. There are four columns: `idx INTEGER PRIMARY KEY, weight INTEGER, key STRING, val STRING`. The `idx` is a unique index for each card, starting at 0. The weight is how often the card should come up. The key and value are the front and reverse sides of the card. You can use the `sqlite3` CLI to create a card deck.
Now build this project with `go build` and run `./sd` to enjoy a fast flash cards experience!
Now build this project with `go build` and run `./sd` to enjoy a fast flash cards experience! The program will display the `key` of a randomly selected card. Press any key to show the `val` of the card. Now press either `y` or `n` depending on whether you got the card correct, and the program adjusts that card's weight.
If you're wondering where the name came from, I named this app after a common type of flash card. 😀
## Performance
SD is designed to be extremely efficient in order to support a very large number of flash cards and should be able to handle millions of cards with ease. If `N` is the number of cards, initializing the program requires `O(N)` time and `O(N)` memory. Selecting a random card and adjusting its weight based on if the user got it correct requires `O(log N)` time. Internally SD uses [segment trees](https://en.wikipedia.org/wiki/Segment_tree) to achieve this time complexity.
SD is designed to be extremely efficient in order to support a very large number of flash cards and should be able to handle millions of cards with ease. If `N` is the number of cards, initializing the program requires `O(N)` time and `O(N)` memory. Selecting a random card and adjusting its weight requires `O(log N)` time. Internally SD uses [segment trees](https://en.wikipedia.org/wiki/Segment_tree) to achieve this time complexity.
A C port for maximal speed and minimal executable size is planned but will probably never happen.