From: Alexis Laferrière <alexis.laf@xymus.net>
Date: Fri, 28 Aug 2015 16:32:41 +0000 (-0400)
Subject: examples/calculator: intro a README.md file
X-Git-Tag: v0.7.8~47^2~10
X-Git-Url: http://nitlanguage.org

examples/calculator: intro a README.md file

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>
---

diff --git a/examples/calculator/README.md b/examples/calculator/README.md
new file mode 100644
index 0000000..9028013
--- /dev/null
+++ b/examples/calculator/README.md
@@ -0,0 +1,15 @@
+Portable calculator built using _app.nit_
+
+# Project structure
+
+* `calculator_logic` defines `CalculatorContext` with all the business logic of a calculator.
+  It takes as input operations and numbers, and outputs the text to display.
+* `calculator` implements the portable graphical interface using the _app.nit_ framework
+* `calculator_test` test `CalculatorContext` as a black box.
+
+# Usage
+
+1. Compile with a call to `make`.
+2. Run with either:
+	1. The desktop version, `bin/calculator`.
+	2. The Android version by install the APK at `bin/calculator.apk`.