1
- ## Noonian
1
+ # Noonian [ ![ Build Status ] ( https://travis-ci.org/scottrhoyt/Noonian.svg?branch=master )] ( https://travis-ci.org/scottrhoyt/Noonian ) [ ![ codecov ] ( https://codecov.io/gh/scottrhoyt/Noonian/branch/master/graph/badge.svg )] ( https://codecov.io/gh/scottrhoyt/Noonian ) ![ Swift ] ( https://img.shields.io/badge/Swift-3.0-orange.svg ) ![ SPM ] ( https://img.shields.io/badge/SPM-Compatible-green.svg )
2
2
3
3
A tool for building Android apps. Inspired by [ a man who had some success in
4
4
building androids] ( http://memory-alpha.wikia.com/wiki/Noonian_Soong ) .
5
5
6
- [ ![ Build Status] ( https://travis-ci.org/scottrhoyt/Noonian.svg?branch=master )] ( https://travis-ci.org/scottrhoyt/Noonian )
7
- [ ![ codecov] ( https://codecov.io/gh/scottrhoyt/Noonian/branch/master/graph/badge.svg )] ( https://codecov.io/gh/scottrhoyt/Noonian )
8
- ![ Swift] ( https://img.shields.io/badge/Swift-3.0-orange.svg )
9
- ![ SPM] ( https://img.shields.io/badge/SPM-Compatible-green.svg )
10
-
11
- --------------
12
-
13
- ### Installation
6
+ ## Installation
14
7
15
8
* Clone or [ Download the latest release] ( https://github.com/scottrhoyt/Noonian/releases )
16
9
* ` cd Noonian `
@@ -21,7 +14,7 @@ building androids](http://memory-alpha.wikia.com/wiki/Noonian_Soong).
21
14
using Ubuntu 14.04
22
15
* Run ` make install `
23
16
24
- ### Android SDK Requirements
17
+ ## Android SDK Requirements
25
18
26
19
* Java 7+ installed and set in ` $JAVA_HOME `
27
20
* ` $ANDROID_HOME ` is set to an Android SDK directory
@@ -30,14 +23,14 @@ building androids](http://memory-alpha.wikia.com/wiki/Noonian_Soong).
30
23
* You have a valid Android debug key located at ` ~/.android/debug.keystore `
31
24
* To install your app, you must have a simulator running
32
25
33
- ### Usage
26
+ ## Usage
34
27
35
28
Use ` noonian help ` and ` noonian help <action> ` to display command line help.
36
29
37
30
` init ` can be run from any directory, but all other commands must be run from
38
31
your project directory.
39
32
40
- #### Initialize A Project
33
+ ### Initialize A Project
41
34
42
35
` noonian init <Project Name> `
43
36
@@ -48,43 +41,43 @@ your project directory.
48
41
* ` --target <android api target> `
49
42
* ` --activity <name of activity to create> `
50
43
51
- #### Build Your Project
44
+ ### Build Your Project
52
45
53
46
` noonian build `
54
47
55
- #### Package, Sign, Zipalign APK
48
+ ### Package, Sign, Zipalign APK
56
49
57
50
` noonian package `
58
51
59
- #### Install On Active simulator
52
+ ### Install On Active simulator
60
53
61
54
` noonian install `
62
55
63
- #### Build, Package, and Install
56
+ ### Build, Package, and Install
64
57
65
58
` noonian all `
66
59
67
- ### Configuration
60
+ ## Configuration
68
61
69
62
Noonian is configured via a ` .noonian.yml ` file. ` noonian init ` will create a
70
63
basic configuration file for you with the minimum necessary settings, but you
71
64
can modify it to further suit your needs.
72
65
73
- #### Project Settings
66
+ ### Project Settings
74
67
75
68
* ` app_name: <app name> ` specifies the name of your app for packaging and
76
69
installation purposes.
77
70
* ` target: <target name> ` specified which APIs to build against and package.
78
71
* ` build_tools: <tools version> ` specifies which version of the SDK build tools
79
72
to use.
80
73
81
- #### Before/After
74
+ ### Before/After Commands
82
75
83
76
All actions other than ` init ` can be configured with shell commands to run
84
77
before and after the action by using the ` before_<action> ` and ` after_<action> `
85
78
keys. The value can either be a single command or an array of commands.
86
79
87
- #### Example Configuration
80
+ ### Example Configuration
88
81
89
82
``` yaml
90
83
# # You can use comments to annotate your configuration
@@ -103,9 +96,9 @@ after_install:
103
96
- echo we finished!
104
97
` ` `
105
98
106
- ### Troubleshooting
99
+ ## Troubleshooting
107
100
108
- #### ` make install` fails:
101
+ ### ` make install` fails:
109
102
110
103
* Make sure you have Swift 3+ installed
111
104
* **macOS**: via Xcode 8+ or a manually installed toolchain from swift.org
@@ -120,7 +113,7 @@ after_install:
120
113
will be unable to create an initial configuration for you. You can manually
121
114
copy `example.noonian.yml` to your project directory.
122
115
123
- # ### `noonian <action>` fails:
116
+ # ## `noonian <action>` fails:
124
117
125
118
* Check `$ANDROID_HOME` is defined
126
119
* Check `$JAVA_HOME` is defined
0 commit comments