Skip to content

Commit c8a08fe

Browse files
author
nicolaiparlog
committed
Improved README.
1 parent 7faa8f0 commit c8a08fe

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,52 @@
11
# LibFX
22

3-
**LibFX** has no strict goal for a feature set. It collects functionality the developer (currently only one) created for his use in other projects but are abstract enough to be generally helpful:
4-
* [Nestings](https://github.com/CodeFX-org/LibFX/wiki/Nestings): using all the power of JavaFX' properties for nested object aggregations
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).
54

6-
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 quickly addressed and feature requests as well as forks and pull requests are welcome.
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.
76

8-
## License
7+
## Features
98

10-
License details can be found in the `LICENSE` file in the same folder as this readme. The information provided there is binding but the gist is: **LibFX** is licensed under the GPL but if that does not suit your licensing models, other arrangements are possible (contact me).
9+
These features are present in the latest release:
10+
11+
* [Nestings](https://github.com/CodeFX-org/LibFX/wiki/Nestings): using all the power of JavaFX' properties for nested object aggregations
1112

1213
## Documentation
1314

14-
The best documentation are the tests. Understandably nobody wants to dig into the tests to understand what the classes do so there is also extensive Javadoc and examples. The best way to get to know a feature is to check out its description in the [wiki](https://github.com/CodeFX-org/LibFX/wiki).
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).
1516

1617
If anything is missing or an explanation proves to be unhelpful, contact me (see below).
1718

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+
1827
## Development
1928

2029
Some information about how this library is developed:
2130

2231
* The [issue tracker](https://github.com/CodeFX-org/LibFX/issues) is actively used so it is the place to report bugs and request features.
23-
* Releases are marked as such and can be accessed [here](https://github.com/CodeFX-org/LibFX/releases).
24-
* 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 the other branches to see what is being worked on.
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.
2533
* 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.
2634

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+
2745
## Contact
2846

2947
Nicolai Parlog <br>
3048
CodeFX
3149

32-
URL: http://codefx.org <br>
50+
Web: http://codefx.org <br>
3351
3452
Key: http://keys.gnupg.net/pks/lookup?op=vindex&search=0xA47A795BA5BF8326 <br>

0 commit comments

Comments
 (0)