diff --git a/README.md b/README.md index b8b4827c..9f1e71e5 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,13 @@ It is based on Java's Collection Library and FastUtil. But its focus is a different one. ## Main Features: -ArraysList, HashSet/Map (Linked & HashControl), TreeSet/Map (RB & AVL), Priority Queue. - +- ArraysList +- HashSet/Map (Linked & HashControl) +- TreeSet/Map (RB & AVL) +- Priority Queue. +- Streams +- SplitIterators +- Iterators # How to install Using Gradle: @@ -21,13 +26,27 @@ dependencies { } ``` +# Contributing +If you want to contribute. +This project is created using gradle and java and my Template Library only. Nothing extra. +If you setup gradle the library will be downloaded automatically. + +Where is everything stored? +- Variables and ClassNames are define [here](https://github.com/Speiger/Primitive-Collections/blob/master/src/builder/java/speiger/src/builder/GlobalVariables.java) +- Templates are stored [here](https://github.com/Speiger/Primitive-Collections/tree/master/src/builder/resources/speiger/assets/collections/templates) +- Tests can be found [here](https://github.com/Speiger/Primitive-Collections/tree/master/src/test/java/speiger/src/collections) + +Please if you want to contribute follow the [Rule-Sheet](https://github.com/Speiger/Primitive-Collections/blob/master/RuleSheet.md). It keeps everything in line. + + # How to Build -The SourceCode can be already generated via: +The SourceCode can be generated via: /gradlew.bat generateSource -to build the jar -/gradlew.bat build -do not combine the commands because they can not be executed at the same time. + +to build the jar: +/gradlew.bat build +do not combine the commands because they can not be executed at the same time. ## Current Down Sides (Random order) - Testing for Sub Maps/Sets/Lists are only in a very basic way tested