summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index 164f0b3..879e026 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,15 @@
# Balalaika
School project of a lyrics game site.
+## Set up env
+Create a .env file and fill using env_example as a guide.
+
## 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`
+You can install the app with
+`cargo install cargo-run-script`
Available scripts:
```
@@ -15,7 +19,7 @@ db_start
db_stop
```
-The stop/start scripts assume you're using systemd.
+The start/stop scripts assume that you're using systemd.
If not, just start/stop the mariadb service manually.
## Changes
@@ -23,7 +27,3 @@ If not, just start/stop the mariadb service manually.
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".