about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fa6b6f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# OSSE (Overly Simple Searche Engine) (Oh-Si)
+
+An attempt to make a "functional" search engine while learning Rust :^)
+
+## Building
+
+### 1. Setup your environment
+
+#### With Nix:
+```
+$ nix develop
+```
+or
+```
+$ nix-shell shell.nix
+```
+
+#### Otherwise:
+
+Install cargo through your preferred method.
+
+
+### 2. Build!
+
+```
+$ cargo build
+```