docs: add README.md

qtslab · Oct 17, 2024 · f1ddf8b · f1ddf8b
1 parent 0871ec8
commit f1ddf8b
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# QTS and AE-QTS solving 0/1 kncpsack problem implemented in Rust
+
+This is a Rust implementation of the QTS and AE-QTS algorithms for solving the 0/1 knapsack problem. The algorithms are described in the following papers:
+
+The implementation is based on the following papers:
+
+- [arXiv - AE-QTS](https://arxiv.org/abs/2311.12867v2)
+
+## Usage
+
+### Configuration
+
+the configuration file is located in `config/config.toml`
+
+### Running the program
+
+```sh
+cargo run --release
+```