prototype: init directory with nixdoc outline

4 files changed, 36 insertions, 0 deletions

diff --git a/prototypes/README.md b/prototypes/README.md
new file mode 100644
index 000000000000..2674181735af
--- /dev/null
+++ b/prototypes/README.md
@@ -0,0 +1,11 @@
+# prototypes
+
+Sometimes I have an idea for something, but it's very much not fleshed
+out, and so... I start with `cargo new <name>`, and start coding.
+Sometimes these are just design documents, and sometimes they are
+half-functional tools.
+
+This directory is meant for me, or you if you are curious about the
+way I think, and approach problems.  None of these tools are really
+working, or else they would be in the `apps/` or `development/` trees
+😉 - so be warned.
diff --git a/prototypes/nixdoc/Cargo.toml b/prototypes/nixdoc/Cargo.toml
new file mode 100644
index 000000000000..a4b5c2eca1b2
--- /dev/null
+++ b/prototypes/nixdoc/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "nixdoc"
+version = "0.1.0"
+authors = ["Mx Kookie <kookie@spacekookie.de>"]
+edition = "2018"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
diff --git a/prototypes/nixdoc/README.md b/prototypes/nixdoc/README.md
new file mode 100644
index 000000000000..0b5a0502f291
--- /dev/null
+++ b/prototypes/nixdoc/README.md
@@ -0,0 +1,13 @@
+# nixdoc
+
+Imagine rustdoc, but for nix.
+
+
+* Parse `.nix` files
+* Generate documentation, based on outputs
+* Modules are already documented in nixos options
+  * What could this do better?  Better browsability?  Maybe just a
+    different front-end for the existing parsing mechanism?
+* Parsing comments, and associating them with entries?
+* Document function inputs/ outputs
+* 
diff --git a/prototypes/nixdoc/src/main.rs b/prototypes/nixdoc/src/main.rs
new file mode 100644
index 000000000000..e7a11a969c03
--- /dev/null
+++ b/prototypes/nixdoc/src/main.rs
@@ -0,0 +1,3 @@
+fn main() {
+    println!("Hello, world!");
+}