Skip to content

Commit 892d3f9

Browse files
author
nicolaiparlog
committed
Merge branch 'develop' into master.
2 parents efced75 + e384966 commit 892d3f9

File tree

8 files changed

+1208
-1071
lines changed

8 files changed

+1208
-1071
lines changed

.settings/org.eclipse.jdt.ui.prefs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ sp_cleanup.always_use_this_for_non_static_field_access=false
7878
sp_cleanup.always_use_this_for_non_static_method_access=false
7979
sp_cleanup.convert_functional_interfaces=true
8080
sp_cleanup.convert_to_enhanced_for_loop=false
81-
sp_cleanup.correct_indentation=true
81+
sp_cleanup.correct_indentation=false
8282
sp_cleanup.format_source_code=true
8383
sp_cleanup.format_source_code_changes_only=false
8484
sp_cleanup.insert_inferred_type_arguments=false

GPL3.0

Lines changed: 674 additions & 0 deletions
Large diffs are not rendered by default.

LICENSE

Lines changed: 4 additions & 673 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 44 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,54 @@
11
# LibFX
22

3-
This is the place where we tell you, who we are, what this project is all about and why you really need it!
3+
**[LibFX](http://libfx.codefx.org)** has no strict goal for a feature set. It collects functionality I created for my use in other projects but are abstract enough to be generally helpful. Many will revolve around JavaFX (hence the name).
44

5-
## Who?
5+
This somewhat vague sentiment does not translate to quality! The code is clean, which especially includes thorough testing. It is also extensively documented and contains many examples. Bugs will be addressed quickly and feature requests as well as forks and pull requests are welcome.
66

7-
Well, we must disappoint you: there is no "we". Currently it's only me, Nicolai. ;)
7+
## Features
88

9-
## What?
9+
These features are present in the latest release:
1010

11-
And the answer to _What?_ might also be underwhelming as I can't really tell you what will come of this. It will at least involve _JavaFX_ (hence the name) and some collections. In general, I've got two things in mind:
12-
* I wanna search my projects for reusable chunks of code. Whatever I find will be redesigned, tested, well-documented and finally published here.
13-
* I've got some ideas of things I'd like to implement and see where it takes me.
11+
* [Nestings](https://github.com/CodeFX-org/LibFX/wiki/Nestings): using all the power of JavaFX' properties for nested object aggregations
1412

15-
Features will be developed in feature branches so this master might remain empty for a while. Check out the other branches to see what is being developed.
13+
## Documentation
1614

17-
## Why?
15+
The best documentation are the tests. But understandably nobody wants to dig into them just to understand what the classes do so there are also examples and extensive Javadoc. The best way to get to know a feature is to check out the corresponding article in the [wiki](https://github.com/CodeFX-org/LibFX/wiki). It will include a high level explanation as well as links to demos and the best entry point into the documentation. The Javadoc of the current version is published [here](http://libfx.codefx.org/javadoc).
1816

19-
So why should you use this? Yes, why indeed...
17+
If anything is missing or an explanation proves to be unhelpful, contact me (see below).
2018

21-
Until this very hazy text changes, you should not use this code as-is. Check it out, look at it, get some ideas, change it, use it, ... go crazy with it! (But remember, it's licensed under GPL.) At some point, a part of the code will become stable and there will be releases - at least that's the hope. ;)
19+
## License
20+
21+
License details can be found in the *LICENSE* file in the project's root folder. The information provided there is binding but the gist is: **LibFX** is licensed under the GPL but if that does not suit your licensing model, other arrangements are possible (contact me; see below).
22+
23+
## Releases
24+
25+
Releases are published [here](https://github.com/CodeFX-org/LibFX/releases). The release notes also contain the Maven coordinates for each version available in Maven Central.
26+
27+
## Development
28+
29+
Some information about how this library is developed:
30+
31+
* The [issue tracker](https://github.com/CodeFX-org/LibFX/issues) is actively used so it is the place to report bugs and request features.
32+
* As per [GIT branching model](http://nvie.com/posts/a-successful-git-branching-model/) features are developed in feature branches. If you are curious, you can check out some branches to see what is being worked on.
33+
* This is a [Maven](http://maven.apache.org/) project, so in case you want to check out the code, make sure your IDE knows about Maven.
34+
35+
## Infrastructure
36+
37+
The best starting point to everything regarding **LibFX** is [libfx.codefx.org](http://libfx.codefx.org).
38+
39+
The library has its home on [GitHub](https://github.com/CodeFX-org/LibFX) where the following features are especially noteworthy:
40+
* the [issue tracker](https://github.com/CodeFX-org/LibFX/issues), which is actively used for development
41+
* the [wiki](https://github.com/CodeFX-org/LibFX/wiki), where all features are introduced with their own article
42+
43+
I have a blog at [codefx.org](http://blog.codefx.org) where I might occasionally blog about **LibFX**. Those posts are filed under [their own tag](http://blog.codefx.org/tag/libfx/).
44+
45+
I use Eclipse and my project settings (like compiler warnings, formatter and save actions) can be found in the repository folder **.settings**. I do this to make it easier for contributors to cope with my obsession for warning free and consistently formatted code.
46+
47+
## Contact
48+
49+
Nicolai Parlog <br>
50+
CodeFX
51+
52+
Web: http://codefx.org <br>
53+
54+
Key: http://keys.gnupg.net/pks/lookup?op=vindex&search=0xA47A795BA5BF8326 <br>

pom.xml

Lines changed: 71 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,65 @@
22
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
33
<modelVersion>4.0.0</modelVersion>
44

5+
<!-- PROJECT COORDINATES -->
6+
57
<groupId>org.codefx.libfx</groupId>
68
<artifactId>LibFX</artifactId>
7-
<version>0.1.0</version>
9+
<version>0.1.1</version>
810
<packaging>jar</packaging>
911

12+
<!-- PROJECT META INFORMATION -->
13+
1014
<name>LibFX</name>
11-
<url>http://libfx.codefx.org</url>
1215
<description>LibFX provides utility classes for JavaFX.</description>
16+
<url>http://libfx.codefx.org</url>
17+
1318
<scm>
1419
<url>https://github.com/CodeFX-org/LibFX</url>
20+
<connection>scm:git:git://github.com/CodeFX-org/LibFX.git</connection>
1521
</scm>
22+
1623
<issueManagement>
1724
<url>https://github.com/CodeFX-org/LibFX/issues</url>
1825
<system>GitHub</system>
1926
</issueManagement>
2027

28+
<distributionManagement>
29+
<snapshotRepository>
30+
<id>ossrh</id>
31+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
32+
</snapshotRepository>
33+
</distributionManagement>
34+
35+
<licenses>
36+
<license>
37+
<name>GNU General Public License, Version 3.0</name>
38+
<url>http://www.gnu.org/licenses/gpl-3.0.txt</url>
39+
<distribution>repo</distribution>
40+
<comments>Dual licensing under a license without copyleft effect is possible. Contact [email protected].</comments>
41+
</license>
42+
</licenses>
43+
44+
<!-- ORGANIZATION META INFORMATION -->
45+
2146
<organization>
2247
<name>CodeFX</name>
2348
<url>http://codefx.org</url>
2449
</organization>
2550

51+
<developers>
52+
<developer>
53+
<id>nipa</id>
54+
<name>Nicolai Parlog</name>
55+
<email>[email protected]</email>
56+
<organization>CodeFX</organization>
57+
<organizationUrl>http://codefx.org</organizationUrl>
58+
<timezone>+1</timezone>
59+
</developer>
60+
</developers>
61+
62+
<!-- BUILD -->
63+
2664
<properties>
2765
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2866
</properties>
@@ -44,6 +82,7 @@
4482

4583
<build>
4684
<resources>
85+
<!-- exclude the demo folder from the build process -->
4786
<resource>
4887
<directory>src/demo/java</directory>
4988
<excludes>
@@ -53,6 +92,7 @@
5392
</resources>
5493
<plugins>
5594
<plugin>
95+
<!-- specify using Java 8 -->
5696
<groupId>org.apache.maven.plugins</groupId>
5797
<artifactId>maven-compiler-plugin</artifactId>
5898
<version>3.1</version>
@@ -62,6 +102,7 @@
62102
</configuration>
63103
</plugin>
64104
<plugin>
105+
<!-- create sources.jar -->
65106
<groupId>org.apache.maven.plugins</groupId>
66107
<artifactId>maven-source-plugin</artifactId>
67108
<version>2.3</version>
@@ -75,6 +116,7 @@
75116
</executions>
76117
</plugin>
77118
<plugin>
119+
<!-- create javadoc.jar -->
78120
<groupId>org.apache.maven.plugins</groupId>
79121
<artifactId>maven-javadoc-plugin</artifactId>
80122
<version>2.9.1</version>
@@ -87,6 +129,33 @@
87129
</execution>
88130
</executions>
89131
</plugin>
132+
<plugin>
133+
<!-- sign all jars and pom -->
134+
<groupId>org.apache.maven.plugins</groupId>
135+
<artifactId>maven-gpg-plugin</artifactId>
136+
<version>1.5</version>
137+
<executions>
138+
<execution>
139+
<id>sign-artifacts</id>
140+
<phase>verify</phase>
141+
<goals>
142+
<goal>sign</goal>
143+
</goals>
144+
</execution>
145+
</executions>
146+
</plugin>
147+
<plugin>
148+
<!-- deploy to sonatype OSSRH -->
149+
<groupId>org.sonatype.plugins</groupId>
150+
<artifactId>nexus-staging-maven-plugin</artifactId>
151+
<version>1.6.2</version>
152+
<extensions>true</extensions>
153+
<configuration>
154+
<serverId>ossrh</serverId>
155+
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
156+
<autoReleaseAfterClose>false</autoReleaseAfterClose>
157+
</configuration>
158+
</plugin>
90159
</plugins>
91160
</build>
92161

0 commit comments

Comments
 (0)