initial commit

1 files changed, 34 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..26a1120
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# neb examples
+
+Some examples of neb code, using well known and/or widely available problems.
+
+**All examples should be runnable with the latest neb-python interpreter.**
+As the compiler (neb-d) matures, it should be able to run more and more of
+these examples.
+
+The purpose of this repo is two-fold:
+1. Provide working examples to anyone (including my future self) who is
+interested in writing *scare-quotes* ideomatic neb.
+2. By working through examples, locate the rough edges of the language
+(where do things not work/look-or-feel wrong), and use that to *refine* the
+language (both the core syntax and available functions in a standard lib).
+
+## is this really ideomatic neb?
+
+I mean, I don't have a PEP20/PEP8-esque reference document, but this is probably
+as close as things get to ideomatic at this point. Also, as the language 
+changes for whatever reason(s), so too will some of the styles (both to 
+accomodate breaking changes, and to take advantage of new formats). I also
+try to make comments around bits of code I find particularly clunky, so those
+areas are probably the most likely to change.
+
+## dude, your code is bad...
+
+I'm sure you're right! I'd love to hear any specific feedback on either the
+language or the code written in it. I am not the World's Best Coder by any
+stretch, and so am very open to learning new things and rectifying my mistakes!
+
+## key to examples
+ - `aoc`: [Advent of Code](https://adventofcode.com)
+ - `p99`: [Ninety-Nine Lisp Problems](https://www.ic.unicamp.br/~meidanis/courses/mc336/problemas-lisp/L-99_Ninety-Nine_Lisp_Problems.html)
+ - `rosetta`: [Rosetta Code](https://rosettacode.org/wiki/Rosetta_Code) (Note: the names of the problems don't line up well)