Skip to content
Newer
Older
100644 123 lines (93 sloc) 3.9 KB
08fa5c3 @koraktor Add Coveralls badge to README
authored
1 Mavanagaiata
f469b51 @koraktor Added a README
authored
2 ============
3
0fb060e @koraktor Merge branch '0.7'
authored
4 [![Build Status](https://travis-ci.org/koraktor/mavanagaiata.svg?branch=master)](https://travis-ci.org/koraktor/mavanagaiata)
5 [![Coverage Status](https://coveralls.io/repos/koraktor/mavanagaiata/badge.svg?branch=master&service=github)](https://coveralls.io/github/koraktor/mavanagaiata)
08fa5c3 @koraktor Add Coveralls badge to README
authored
6
f469b51 @koraktor Added a README
authored
7 Mavanagaiata – \[maˈvanaˈɡaːjaˈta\] – is a Maven plugin providing information
8 about the Git repository of your project.
9
10 ## Requirements
11
7ebd442 @koraktor Update Maven requirement in README
authored
12 * Maven 2.2.1 or newer
f469b51 @koraktor Added a README
authored
13
a02fe32 @koraktor Updated README
authored
14 ## Dependencies
15
d02b0f6 @koraktor Mention Commons IO dependency in the README
authored
16 * Apache Commons IO 2.4
c948c80 @koraktor Update README
authored
17 * JGit 3.7.1
a02fe32 @koraktor Updated README
authored
18
f469b51 @koraktor Added a README
authored
19 ## Installation
20
8cb9ac7 @leif81 typo in readme
leif81 authored
21 Mavanagaiata is available from the Central Repository and will be automatically
a02fe32 @koraktor Updated README
authored
22 installed by Maven once you add it as a plugin to your project. If you want to
23 have the newest features available in the development code or you want to hack
24 on the code you are free to clone the Git repository and install it manually.
25 You can do so using the following commands:
f469b51 @koraktor Added a README
authored
26
27 ```bash
28 $ git clone git://github.com/koraktor/mavanagaiata.git
29 $ cd mavanagaiata
30 $ mvn install
31 ```
32
33 ## Usage
34
35 To use the Mavanagaiata plugin in your Maven project you will have to include
36 the plugin in your POM and add the configuration suitable for your needs:
37
38 ```xml
39 <project ...>
40 ...
41 <build>
42 <plugins>
43 <plugin>
44 <groupId>com.github.koraktor</groupId>
45 <artifactId>mavanagaiata</artifactId>
46 <executions>
47 <execution>
48 <id>load-git-branch</id>
49 <goals>
50 <goal>branch</goal>
51 </goals>
52 </execution>
53 </executions>
54 </plugin>
55 ...
56 </plugins>
57 ...
58 </build>
59 </project>
60 ```
61
b7415d2 @koraktor Remove configuration usage from the README
authored
62 For more information on the existing goals and their configuration can be found
63 in the [Plugin Documentation][3].
64
0fb060e @koraktor Merge branch '0.7'
authored
65 A more complete usage example can be found in Mavanagaiata’s own [`pom.xml`][4].
b7415d2 @koraktor Remove configuration usage from the README
authored
66 Yes, Mavanagaiata is used to build Mavanagaiata.
324e0e9 @koraktor Documented configuration properties
authored
67
f469b51 @koraktor Added a README
authored
68 ## About the name
69
70 The name is a completely invented word hopefully sounding like a mighty god of
71 an ancient, Southeast Asian primitive people or a similar mighty monster that
72 same primitive people is afraid of.
73
c22fdf1 @koraktor Use the typographically correct apostrophe in README
authored
74 Instead, it’s just a combination of the command-line tools of Maven and Git:
f469b51 @koraktor Added a README
authored
75 `mvn` and `git`. Each character is suffixed with the character `a`.
76
77 In Java code you would write this as:
78
79 ```java
80 ("mvn" + "git").replaceAll("(.)", "$1a")
81 => "mavanagaiata"
82 ```
83
84 ## Contribute
85
86 Mavanagaiata is an open-source project. Therefore you are free to help
c22fdf1 @koraktor Use the typographically correct apostrophe in README
authored
87 improving it. There are several ways of contributing to Mavanagaiata’s
f469b51 @koraktor Added a README
authored
88 development:
89
90 * Build projects using it and spread the word.
91 * Report problems and request features using the [issue tracker][2].
92 * Write patches yourself to fix bugs and implement new functionality.
93 * Create a Mavanagaiata fork on [GitHub][1] and start hacking. Extra points for
c22fdf1 @koraktor Use the typographically correct apostrophe in README
authored
94 using GitHub’s pull requests and feature branches.
f469b51 @koraktor Added a README
authored
95
96 ## License
97
98 This code is free software; you can redistribute it and/or modify it under the
99 terms of the new BSD License. A copy of this license can be found in the
100 included LICENSE file.
101
102 ## Credits
103
104 * Sebastian Staudt -- koraktor(at)gmail.com
9e70bec @koraktor Give credit to Pablo Graña
authored
105 * Pablo Graña -- pablo.grana(at)globant.com
d7e925e @koraktor Added Santeri Vesalainen to contributors
authored
106 * Henning Schmiedehausen -- hgschmie(at)fb.com
107 * Santeri Vesalainen -- santeri.vesalainen(at)gmail.com
bcb5472 @koraktor Add Patrick Kaeding to contributors
authored
108 * Patrick Kaeding -- pkaeding(at)atlassian.com
c948c80 @koraktor Update README
authored
109 * Kay Hannay -- klinux(at)hannay.de
f469b51 @koraktor Added a README
authored
110
ce3c4fd @koraktor Added some links to the README
authored
111 ## See Also
112
113 * [Mavanagaiata home](https://koraktor.de/mavanagaiata)
114 * [GitHub project page](https://github.com/koraktor/mavanagaiata)
e1e9ed7 @koraktor Add link to Gitter chat
authored
115 * [Gitter chat](https://gitter.im/koraktor/mavanagaiata)
ce3c4fd @koraktor Added some links to the README
authored
116 * [Google group](http://groups.google.com/group/mavanagaiata)
117 * [Ohloh profile](http://www.ohloh.net/projects/mavanagaiata)
118
f469b51 @koraktor Added a README
authored
119 [1]: https://github.com/koraktor/mavanagaiata
120 [2]: https://github.com/koraktor/mavanagaiata/issues
b7415d2 @koraktor Remove configuration usage from the README
authored
121 [3]: http://koraktor.de/mavanagaiata/plugin-info.html
122 [4]: https://github.com/koraktor/mavanagaiata/blob/master/pom.xml
Something went wrong with that request. Please try again.