diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..164f0b3 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Balalaika +School project of a lyrics game site. + +## Setup database +To manage the database through the program's scripts use +`cargo run-script` + +You can install the app with `cargo install cargo-run-script` + +Available scripts: +``` +db_create +db_populate +db_start +db_stop +``` + +The stop/start scripts assume you're using systemd. +If not, just start/stop the mariadb service manually. + +## Changes +### Single parameters ONLY +You can only search a parameter at a time. +This is because Rust needs to process the sql queries ahead of time +in order to make them safe to injection attacks. + +### SearchResults changed its name +Since searchResults was highly unintuitive, +it has been renamed to just "name". |