Adding more info if someone wants to contribute

This commit is contained in:
Speiger 2021-06-22 16:34:32 +02:00
parent 8fee81bd19
commit d1453fbc95
1 changed files with 25 additions and 6 deletions

View File

@ -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,11 +26,25 @@ 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
to build the jar:
/gradlew.bat build
do not combine the commands because they can not be executed at the same time.