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

Commit

Permalink
Update plugin and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AdrianRaFo committed Jul 29, 2017
1 parent 5995248 commit 1a34619
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 16 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 9 additions & 8 deletions macroid-docs/src/main/tut/docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@ section: docs

# Installation

## Version `2.0.0-M5`
## Version `3.0.0`

*Macroid* is packaged in the AAR format and published to [Maven Central](http://central.maven.org/maven2/org/macroid/macroid_2.11/2.0.0-M5/).
*Macroid* is packaged in the AAR format and published to [Maven Central](http://central.maven
.org/maven2/org/macroid/macroid_2.11/3.0.0/).

Assuming sbt version `0.13.x` and [android-sdk-plugin](https://github.com/pfn/android-sdk-plugin)
version `1.2.20` and above, you can add it to your project like this:
Assuming sbt version `0.13.x` and [sbt-android](https://github.com/scala-android/sbt-android)
version `1.7.8` and above, you can add it to your project like this:

```scala
libraryDependencies ++= Seq(
aar("org.macroid" %% "macroid" % "2.0")
aar("org.macroid" %% "macroid" % "3.0.0")
```

If you want to use the SNAPSHOT version you need to add the Sonatype SNAPSHOT repo
Expand All @@ -25,17 +26,17 @@ resolvers +=
"Sonatype OSS Snapshots" at "https://oss.sonatype.org/content/repositories/snapshots"

libraryDependencies ++= Seq(
aar("org.macroid" %% "macroid" % "2.0.1-SNAPSHOT")
aar("org.macroid" %% "macroid" % "3.0.0-SNAPSHOT")
```

## Version `2.0.0-M2` and below
## Version `2.0.0` and below

*Macroid* is an ordinary Scala library and can be added to your sbt project like this:

```scala
resolvers += Resolver.jcenterRepo

libraryDependencies += "org.macroid" %% "macroid" % "2.0.0-M2"
libraryDependencies += "org.macroid" %% "macroid" % "2.0.0"
```

If you are confused about sbt or using Scala on Android in general, [check this out](installation/ScalaOnAndroid.html).
8 changes: 4 additions & 4 deletions macroid-docs/src/main/tut/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ section: docs

# Introduction

*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.
*Macroid* is a modular functional user interface creation language for Android, implemented with
Scala macros.

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+`.
Prerequisites: Scala `2.10.x` or `2.11.x`, Android `API 19+`.

Latest version: `2.0.0-M5` ([installation](Installation.html) | [changelog](Changelog.md)).
Latest version: `3.0.0` ([installation](Installation.html) | [changelog](Changelog.md)).

* [What does it look like](Tutorial.html)
* [How is it different from...](Differences.html)
Expand Down
7 changes: 4 additions & 3 deletions macroid-docs/src/main/tut/docs/installation/ScalaOnAndroid.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,23 @@ 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).
The SDK can be downloaded from the [Android website](http://developer.android.com/sdk/index.html)
or with the IntelliJ Android plugin.
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](/macroid/img/SDK-manager.png)


Alternatively, you can find a UNIX install script in
[*Macroid*’s Travis config](https://github.com/47deg/macroid/blob/master/.travis.yml#L7).

***Note*** If `sbt-android` doesn't find an Android SDK it will download all he need

## The build system

The most important part of the equation is the build system
Expand Down
2 changes: 1 addition & 1 deletion project/plugins.sbt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
addSbtPlugin("org.scala-android" % "sbt-android" % "1.7.7")
addSbtPlugin("org.scala-android" % "sbt-android" % "1.7.8")

addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.5.0")

Expand Down

0 comments on commit 1a34619

Please sign in to comment.