Add README and LICENSE

Author: pmarreck

CODE_MINIMAP.md

@@ -5,6 +5,8 @@
 - PROJECT_PLAN.md: high-level milestones and objective
 - CODE_MINIMAP.md: overview of important files and their purpose
 - .gitignore: ignored paths for build outputs and local indexes
+- README.md: usage, build, and configuration overview
+- LICENSE: MIT license
 - flake.lock: pinned Nix inputs for reproducible dev shell
 - ZIG_RECENT_API_CHANGES_2025.md: Zig 0.14–0.15 API quick reference
 - flake.nix: Nix flake providing dev dependencies (zig_0_15) + sqlite amalgamation env vars

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Peter Marreck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,67 @@
+# codescan
+
+Semantic code search for local repositories.
+
+- Zig CLI + HTTP API
+- Ollama embeddings (default: `bge-large`)
+- sqlite-vec vector storage
+- Hybrid search (vector + lexical)
+- Language plugins (Zig, Elixir, C via tree-sitter)
+
+## Build
+
+```bash
+nix develop -c zig build -Doptimize=ReleaseFast
+```
+
+## Test
+
+```bash
+./test
+```
+
+## Run (CLI)
+
+```bash
+# index
+nix develop -c ./zig-out/bin/codescan index --root <path>
+
+# update (full reindex)
+nix develop -c ./zig-out/bin/codescan update --root <path>
+
+# search
+nix develop -c ./zig-out/bin/codescan search "hash functions" --root <path>
+```
+
+## Run (HTTP)
+
+```bash
+nix develop -c ./zig-out/bin/codescan serve --root <path> --http-host 127.0.0.1 --http-port 8123
+```
+
+## Config
+
+Create `<root>/.codescan/config` to override defaults. Example:
+
+```
+# output=json|human
+output=human
+
+# search tuning
+search_mode=hybrid
+weight_vector=0.7
+weight_lexical=0.3
+
+# ignores
+ignore=**/.git/**, **/.codescan/**
+ignore.zig=**/.zig-cache/**,**/zig-out/**
+```
+
+## Notes
+
+- SQLite vector extension is statically linked (no runtime extension loading).
+- On macOS, fully static userland binaries are not supported by the OS; `libSystem` remains dynamic.
+
+## License
+
+MIT. See `LICENSE`.