Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Commit

Permalink
= docs: Add more samples
Browse files Browse the repository at this point in the history
  • Loading branch information
stanch committed Apr 12, 2015
1 parent ec85d37 commit d27d2b3
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 12 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`.

Expand Down
4 changes: 2 additions & 2 deletions macroid-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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+`.

Expand All @@ -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)
17 changes: 14 additions & 3 deletions macroid-docs/Samples.md
Original file line number Diff line number Diff line change
@@ -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
* http://typesafe.com/activator/template/macroid-akka-pingpong
12 changes: 8 additions & 4 deletions macroid-docs/ScalaOnAndroid.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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).
Expand All @@ -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, <s>follow the instructions for the sbt plugin to
create IDE project files</s>. 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 →
Expand Down
1 change: 0 additions & 1 deletion macroid-docs/Talks.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

* Event: https://codebits.eu/intra/s/proposal/455
* Slides: http://stanch.github.io/codebits2014/
* Video: Coming soon!

## 3<sup>rd</sup> Fun(Lx) meetup

Expand Down

0 comments on commit d27d2b3

Please sign in to comment.