Merge: lib/config: fix doc

[nit.git] / examples / calculator / README.md

diff --git a/examples/calculator/README.md b/examples/calculator/README.md
index 9028013..aa93fed 100644 (file)
--- a/examples/calculator/README.md
+++ b/examples/calculator/README.md
@@ -5,11 +5,38 @@ Portable calculator built using _app.nit_
 * `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
+* `scientific_calculator` refines `calculator` to add scientific operations.
+* `android_calculator` refines `calculator` to get a nicer aesthetic on Android.
+* `ios_calculator` refines `calculator` to get a nicer aesthetic on iOS.
 * `calculator_test` test `CalculatorContext` as a black box.
 
-# Usage
+# Compilation
 
-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`.
+* Compile and run on the desktop (GNU/Linux and OS X) with:
+
+       ~~~
+       make
+       bin/calculator
+       ~~~
+
+* Compile for Android and install on a device or emulator with:
+
+       ~~~
+       make bin/android.apk
+       adb install -r bin/calculator.apk
+       ~~~
+
+* Compile for iOS and run on the simulator with:
+
+       ~~~
+       make bin/android.app
+       ios-sim launch bin/calculator.app
+       ~~~
+
+# Screenshots
+
+![Scientific calculator on Linux with GTK+](doc/linux-scientific.png)
+
+![Scientific calculator on Android](doc/android-scientific.png)
+
+![Scientific calculator on iOS](doc/ios-scientific.png)