From 25d3066677ee1abe541482a9a7179a638a12c0b0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jes=C3=BAs=20P=C3=A9rez?= <jpl@jesusperez.pro>
Date: Mon, 21 Oct 2024 03:26:13 +0100
Subject: [PATCH] core: add ABOUT for quick verification and notes

---
 ABOUT.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 ABOUT.md

diff --git a/ABOUT.md b/ABOUT.md
new file mode 100644
index 0000000..cfeabe4
--- /dev/null
+++ b/ABOUT.md
@@ -0,0 +1,51 @@
+
+# Backend internal interview (rust) - improved  
+
+## Verification
+
+From [input.txt](input.txt) compare output with [output_expected.txt](output_expected.txt)
+
+```bash
+cargo run -q -- -i input.txt -q
+```
+
+From tests
+
+```rust
+cargo test test_expected_metrics
+```
+
+**test_expectd_metrics** can be found at the end of [tests.rs](src/tests.rs)
+
+> DEFAULT_INPUT_PATH and DEFAULT_REG_EXP values can be found in [defs.rs](src/defs.rs)
+
+### For parallel processing
+
+A second file [input_2.txt](input_2.txt) has been created and included in [config.toml](config.toml)
+
+```rust
+cargo run -q
+```
+
+It the same as:
+
+```rust
+cargo run -q -- -c config.toml
+```
+
+> [!NOTE]
+> [config.toml](config.toml) is DEFAULT_CONFIG_PATH if does not exists it will only use DEFAULT_INPUT_PATH [input.txt](input.txt)
+
+## Read Documentation
+
+Build documentation and browse to **main** page
+
+```rust
+cargo doc --no-deps --open
+```
+
+Source code contains doc text.  
+
+## How to use
+
+For more explanations use [how to use](howto.md)
\ No newline at end of file