|
1 | 1 | # LibFX
|
2 | 2 |
|
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** 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 |
4 | 5 |
|
5 |
| -## Who? |
| 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. |
6 | 7 |
|
7 |
| -Well, we must disappoint you: there is no "we". Currently it's only me, Nicolai. ;) |
| 8 | +## License |
8 | 9 |
|
9 |
| -## What? |
| 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). |
10 | 11 |
|
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. |
| 12 | +## Documentation |
14 | 13 |
|
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. |
| 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). |
16 | 15 |
|
17 |
| -## Why? |
| 16 | +If anything is missing or an explanation proves to be unhelpful, contact me (see below). |
18 | 17 |
|
19 |
| -So why should you use this? Yes, why indeed... |
| 18 | +## Development |
20 | 19 |
|
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. ;) |
| 20 | +Some information about how this library is developed: |
| 21 | + |
| 22 | +* 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. |
| 25 | +* 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. |
| 26 | + |
| 27 | +## Contact |
| 28 | + |
| 29 | +Nicolai Parlog <br> |
| 30 | +CodeFX |
| 31 | + |
| 32 | +URL: http://codefx.org <br> |
| 33 | + |
| 34 | +Key: http://keys.gnupg.net/pks/lookup?op=vindex&search=0xA47A795BA5BF8326 <br> |
0 commit comments