Projects/muscl
12
4
Fork 0
Code Issues 68 Pull Requests Actions Packages Releases Activity

Improve documentation
All checks were successful
Build and test / build (push) Successful in 2m41s
Details
Build and test / check (push) Successful in 1m46s
Details
Build and test / check-license (push) Successful in 58s
Details
Build and test / test (push) Successful in 3m7s
Details
Build and test / docs (push) Successful in 5m40s
Details

Browse Source
This commit is contained in:
Oystein Kristoffer Tveit
2025-12-18 02:08:20 +09:00
parent 1f78ca0e25
commit 186adefc22
7 changed files with 91 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/development.md
View File

@@ -1,14 +1,14 @@
# Development and testing
Ensure you have a [rust toolchain](https://www.rust-lang.org/tools/install) installed.
Ensure you have a [Rust toolchain](https://www.rust-lang.org/tools/install) installed.
In order to set up a test instance of mariadb in a docker container, run the following command:
In order to set up a test instance of MariaDB in a docker container, run the following command:
```bash
docker run --rm --name mariadb -e MYSQL_ROOT_PASSWORD=secret -p 3306:3306 -d mariadb:latest
```
This will start a mariadb instance with the root password `secret`, and expose the port 3306 on the host machine.
This will start a MariaDB instance with the root password `secret`, and expose the port 3306 on the host machine.
Run the following command to create a configuration file with the default settings:
@@ -16,10 +16,10 @@ Run the following command to create a configuration file with the default settin
cp ./assets/example-config.toml ./config.toml
```
If you used the docker command above, you can use these settings as is, but if you are running mariadb/mysql on another host, port or with another password, adjust the corresponding fields in `config.toml`.
If you used the docker command above, you can use these settings as is, but if you are running MariaDB/MySQL on another host, port or with another password, adjust the corresponding fields in `config.toml`.
This file will contain your database password, but is ignored by git, so it will not be committed to the repository.
You should now be able to connect to the mariadb instance, after building the program and using arguments to specify the config file.
You should now be able to connect to the MariaDB instance, after building the program and using arguments to specify the config file.
```bash
cargo run -- --config-file ./config.toml <args>
@@ -42,7 +42,8 @@ docker stop mariadb
If you have nix installed, you can easily test your changes in a NixOS vm by running:
```bash
nix run .#vm
nix run .#vm # Start a NixOS VM in QEMU with muscl and MariaDB installed
nix run .#vm-mysql # Start a NixOS VM in QEMU with muscl and MySQL installed
```
You can configure the vm in `flake.nix`