Updated README.md

Regenerated with commons build plugin.

Modified for multi-module project:

Top level README to contain javadoc links for all modules and maven
examples for a few modules.

Module README requires an updated javadoc url and change of title to
remove the module name suffix from 'Apache Commons Numbers' where
appropriate.
13 files changed
tree: 0834e8922971a5412a4827d50345ae1e8f46e789
  1. commons-numbers-angle/
  2. commons-numbers-arrays/
  3. commons-numbers-combinatorics/
  4. commons-numbers-complex/
  5. commons-numbers-complex-streams/
  6. commons-numbers-core/
  7. commons-numbers-examples/
  8. commons-numbers-field/
  9. commons-numbers-fraction/
  10. commons-numbers-gamma/
  11. commons-numbers-primes/
  12. commons-numbers-quaternion/
  13. commons-numbers-rootfinder/
  14. dist-archive/
  15. doc/
  16. siteMods/
  17. src/
  18. .gitattributes
  19. .gitignore
  20. .travis.yml
  21. CONTRIBUTING.md
  22. LICENSE.txt
  23. NOTICE.txt
  24. pom.xml
  25. README.md
  26. RELEASE-NOTES.txt
README.md

Apache Commons Numbers

Build Status Coverage Status Maven Central

The Apache Commons Numbers project provides number types and utilities.

Documentation

More information can be found on the Apache Commons Numbers homepage. The Javadoc for each of the modules can be browsed:

Questions related to the usage of Apache Commons Numbers should be posted to the user mailing list.

Where can I get the latest release?

You can download source and binaries from our download page.

Alternatively you can pull it from the central Maven repositories:

<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-numbers-parent</artifactId>
  <version>1.0</version>
</dependency>

Contributing

We accept Pull Requests via GitHub. The developer mailing list is the main channel of communication for contributors. There are some guidelines which will make applying PRs easier for us:

  • No tabs! Please use spaces for indentation.
  • Respect the code style.
  • Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change.
  • Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running mvn clean test.

If you plan to contribute on a regular basis, please consider filing a contributor license agreement. You can learn more about contributing via GitHub in our contribution guidelines.

License

This code is under the Apache Licence v2.

See the NOTICE.txt file for required notices and attributions.

Donations

You like Apache Commons Numbers? Then donate back to the ASF to support the development.

Additional Resources