diff --git a/README.md b/README.md index e11e5d6..641e3c6 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,7 @@ *Macroid* is the most badass modular functional user interface creation language for Android, implemented with Scala macros. [Some people say](http://www.urbandictionary.com/define.php?term=macroid) it’s also a dead noodle. -Striving to be focused on one thing (GUI), *Macroid* promotes composability, high-level abstractions and advanced features, -like functional reactive programming. +Striving to be focused on one thing (GUI), *Macroid* promotes composability and high-level abstractions. Prerequisites: Scala `2.10.x` or `2.11.x`, Android `API 9+`. diff --git a/macroid-docs/README.md b/macroid-docs/README.md index 6aaffb9..c53882a 100644 --- a/macroid-docs/README.md +++ b/macroid-docs/README.md @@ -3,8 +3,7 @@ *Macroid* is the most badass modular functional user interface creation language for Android, implemented with Scala macros. [Some people say](http://www.urbandictionary.com/define.php?term=macroid) it’s also a dead noodle. -Striving to be focused on one thing (GUI), *Macroid* promotes composability, high-level abstractions and advanced features, -like functional reactive programming. +Striving to be focused on one thing (GUI), *Macroid* promotes composability and high-level abstractions. Prerequisites: Scala `2.10.x` or `2.11.x`, Android `API 9+`. @@ -13,4 +12,5 @@ Latest version: `2.0.0-M4` ([installation](Installation.html) | [changelog](Chan * [What does it look like](Tutorial.html) * [How is it different from...](Differences.html) * [Detailed guide](Guide.html) +* [Sample projects](Samples.html) * [Mailing list](https://groups.google.com/forum/#!forum/macroid) \ No newline at end of file diff --git a/macroid-docs/Samples.md b/macroid-docs/Samples.md index 9b6405e..0ba7463 100644 --- a/macroid-docs/Samples.md +++ b/macroid-docs/Samples.md @@ -1,8 +1,19 @@ # Sample Projects -* https://github.com/macroid/macroid-starter -* https://github.com/stanch/guardbot +#### By yours truly + +* https://github.com/macroid/macroid-starter — a minimal starting project +* https://github.com/stanch/guardbot — Akka + Android + Lego NXT robot +* https://github.com/stanch/macroid-scaladays-demo — Live coding demo from ScalaDays 2014 + +#### By 47deg + +Fine folks at [47deg](http://www.47deg.com/) have developed a few projects with Macroid: + +* https://github.com/47deg/scala-days-android — **the official ScalaDays 2015 app** +* https://github.com/47deg/translate-bubble-android — an application that facilitates text translation on a phone +* https://github.com/47deg/scala-android — many examples of using Scala on Android, featuring Macroid # Activator templates -* http://typesafe.com/activator/template/macroid-akka-pingpong \ No newline at end of file +* http://typesafe.com/activator/template/macroid-akka-pingpong diff --git a/macroid-docs/ScalaOnAndroid.md b/macroid-docs/ScalaOnAndroid.md index a78ee95..c96fd65 100644 --- a/macroid-docs/ScalaOnAndroid.md +++ b/macroid-docs/ScalaOnAndroid.md @@ -15,15 +15,19 @@ This is a short guide that will help you get started. If the instructions below are too dry for your taste, check out these tutorials: * [Android & Scala (part 1)](http://blog.eigengo.com/2014/06/21/android-and-scala/) by [Jan Macháček](https://twitter.com/honzam399) +* [Scala on Android — Preparing the environment (part 1)](http://www.47deg.com/blog/scala-on-android-preparing-the-environment) by [Federico Fernández ](https://twitter.com/@fede_fdz) ## The Android SDK The SDK can be downloaded from the [Android website](http://developer.android.com/sdk/index.html). -You will also need to configure `ANDROID_SDK_HOME` environment variable to point to the installation. +You will also need to configure `ANDROID_HOME` environment variable to point to the installation. To use the bundled libraries, such as the support library, make sure you install the following items in the SDK manager: ![SDK manager screenshot](SDK-manager.png) +Alternatively, you can find a UNIX install script in +[*Macroid*’s Travis config](https://github.com/macroid/macroid/blob/master/.travis.yml#L7). + ## The build system The most important part of the equation is the build system @@ -37,7 +41,7 @@ Currently there are three options: You’ll have to install it from its website. To compile and run Android projects you’ll need the [Android plugin](https://github.com/pfn/android-sdk-plugin). Follow the plugin’s readme page to set things up. -* Use [Gradle](http://www.gradle.org/) and [Android+Scala plugin](https://github.com/saturday06/gradle-android-scala-plugin), which — according to its page — is not stable yet. +* Use [Gradle](http://www.gradle.org/) and [Android+Scala plugin](https://github.com/saturday06/gradle-android-scala-plugin) * **Not recommended**. Just use an IDE without the build system. For Eclipse you’ll need the [ADT plugin](http://developer.android.com/tools/sdk/eclipse-adt.html), [Scala IDE](http://scala-ide.org/) and [AndroidProguardScala plugin](https://github.com/banshee/AndroidProguardScala). @@ -51,8 +55,8 @@ You will need to have the [Scala](http://plugins.jetbrains.com/plugin/?id=1347) and [sbt](http://plugins.jetbrains.com/plugin/5007?pr=idea) plugins installed. Below I am assuming that you are using the first building option, i.e. sbt. -Once you have the build running from the command line, follow the instructions for the sbt plugin to -create IDE project files. +Once you have the build running from the command line, follow the instructions for the sbt plugin to +create IDE project files. Since IDEA 14, you just need to import the project and specify Android SDK as its SDK. Inside IDEA, you can use the sbt console to run the project. Alternatively, the “run” button could be reconfigured for that purpose: go to Run → Edit Configurations → diff --git a/macroid-docs/Talks.md b/macroid-docs/Talks.md index c7d72ea..6e03a69 100644 --- a/macroid-docs/Talks.md +++ b/macroid-docs/Talks.md @@ -4,7 +4,6 @@ * Event: https://codebits.eu/intra/s/proposal/455 * Slides: http://stanch.github.io/codebits2014/ -* Video: Coming soon! ## 3rd Fun(Lx) meetup