restructure repo into bin, lib and macros

1 files changed, 35 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..9a9e0ca
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,35 @@
+## nix-analyzer
+
+`nix-analyzer` intends to be a static analysis tool for the
+Nix programming language.
+
+For the time-being, `nix-analyzer` works only with ASTs
+produced by the `rnix-parser` crate and does not evaluate
+any nix code. 
+
+## Architecture
+
+`nix-analyzer` has the following components:
+
+- `bin`: the CLI/entrypoint
+- `lib`: library of lints and utilities to define these
+  lints
+- `macros`: procedural macros to help define a lint
+
+### `bin`
+
+This is the main point of interaction between `nix-analyzer`
+and the end user. It's output is human-readable and should
+also support JSON/errorfmt outputs for external tools to
+use.
+
+### `lib`
+
+A library of AST-based lints and utilities to help write
+those lints. It should be easy for newcomers to write lints
+without being familiar with the rest of the codebase.
+
+### `macros`
+
+This crate intends to be a helper layer to declare lints and
+their metadata.