CONTRIBUTING.md

Contribute to the jme-alloc project:

1. Clone the repository locally on your disk:

$ git clone https://github.com/Software-Hardware-Codesign/jme-alloc.git

2. Checkout to your new feature branch (always use good descriptive names for what you will do):

$ git checkout master -b 'feature-branch'

3. Add your changes.
4. Compile and assemble the library locally using:

$ ./gradlew clean && \
  ./gradlew :jme3-alloc:compileJava && \
  ./gradlew :jme3-alloc-native:compileX86_64 && \
  ./gradlew :jme3-alloc-native:copyNatives && \
  ./gradlew :jme3-alloc:assemble

Notice: change between task compileX86_64 and task compileX86 depending on your system architecture.

5. Test the library by running the examples using:

$ ./gradlew :jme3-alloc-examples:run

6. Add your changes and commit:

$ git add ./jme3-alloc-examples && git commit -m 'file: changes made' \
  && git push origin 'feature-branch'

7. If you run a windows a machine, make sure to install gitbash first.