init

README.md

@@ -0,0 +1,35 @@
+# Mousquet
+
+Utility for making rough, euristic estimations of code similarity between
+implementations.
+
+The similarity algorithm is based on token sequence matching, like some other
+software serving the same purpose. This aproach has many limitations but may fit
+some use cases.
+
+## Example
+
+```bash
+$ mousquetaire 'examples/primes_1.py' 'examples/primes_2.py'
+```
+
+![screenshot](./assets/screenshot.png)
+
+## Build
+
+### Dependencies
+
+- cargo
+  - Install cargo through rustup
+    - `pacman -S rustup`
+    - `curl --proto '=https' --tlsv1.2 -sSf 'https://sh.rustup.rs' | sh`
+  - Use any toolchain
+    - `rustup default stable`
+
+## Building
+
+```bash
+cargo build --release
+```
+
+Find the binary at `mousquetaire/target/release/mousquetaire`.