X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;f=README.md;h=22e1229a1d405b9b57ed3bf4b96a82e13fe98e86;hb=f742d8cf60cd21f626298bf68ca17d4179cf589e;hp=5d8701ee9af1ca68eeb13455798058e8e4b781e4;hpb=5646acc5cf0637f16f48603c6ad4c8cc988987bf;p=TinyThreePassCompiler%2F.git

diff --git a/README.md b/README.md
index 5d8701e..22e1229 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
 # TinyThreePassCompiler
+
+# The problem
+
+This problem is derived from the [Tiny Three-Pass Compiler kata from codewars](https://www.codewars.com/kata/5265b0885fda8eac5900093b)
+and  basically it is about writing a three-pass compiler for a simple programming
+language into a small assembly language which syntax is like follows:
+
+```bash
+[ a b ] a*a + b*b
+```
+> a^2 + b^2
+
+```bash
+[ first second ] (first + second) / 2
+```
+> average of two numbers
+
+
+# How is this implementation different from the original kata
+
+The plan for this implementation is to make it work not with JSON structures but
+with protocol buffers, the reason is basically just to practice those technologies
+but it is also true that in a real compiler saving and transporting binaries and
+not text as it would be the case for JSON could mean a significant improvement.
+