https://github.com/f2prateek/khaos-android-maven-library

A Khaos template to quickly scaffold new Android Libraries built with Maven.
https://github.com/f2prateek/khaos-android-maven-library

Last synced: about 1 month ago
JSON representation

A Khaos template to quickly scaffold new Android Libraries built with Maven.

• Host: GitHub
• URL: https://github.com/f2prateek/khaos-android-maven-library
• Owner: f2prateek
• Created: 2014-11-07T16:58:02.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2014-11-08T05:46:20.000Z (about 10 years ago)
• Last Synced: 2023-03-24T08:21:49.175Z (over 1 year ago)
• Language: Java
• Homepage:
• Size: 172 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
khaos-android-maven-library

===========================

A [Khaos](https://github.com/segmentio/khaos) template to start new Android Libraries built with Maven quickly.

Installation

============

Install Node and khaos if you haven't already done so:

    $ brew install node

    $ npm install -g khaos

Save the template locally with:

    $ khaos --save f2prateek/khaos-android-maven-library android-maven-library

This is optional, you can directly create projects from the Github repo too.

Usage

=====

Create a new project with:

    $ khaos android-maven-library my-project

If you haven't saved the template locally, you can also use the command below to generate a project.

    $ khaos create f2prateek/khaos-android-maven-library my-project

This will prompt you for the following:

         description: A one-liner about what your project will do. This will be used in the generated pom and Readme.

         packageName: The Java package name it should live under. This will also be used as the Maven groupId.

               owner: Your full name, used in the pom and in the genrated copyright.

      githubUserName: Your Github username

![Screenshot](https://photos-4.dropbox.com/t/1/AAD3PPZtVQCOOxyDaUuXUD55W8YjXGoyT5xSQbo4XXIKBg/12/11371156/png/1024x768/3/1415386800/0/2/Screenshot%202014-11-07%2010.27.13.png/jF8twFHCLzKv3wJ-JeRpn4EI--4bgiPNRqDBL3Wl1jk)

By default, all the class files are put int the `java` folder directly. You'll have to manually create the package structure, but everything other than should work right away!

Verify it builds with `mvn clean verify`!

TODO

====

* Generate package directory structure from the package name

License

=======

    Copyright 2014 Prateek Srivastava

    Licensed under the Apache License, Version 2.0 (the "License");

    you may not use this file except in compliance with the License.

    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software

    distributed under the License is distributed on an "AS IS" BASIS,

    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

    See the License for the specific language governing permissions and

    limitations under the License.