Skip to content

How to use Arithmos ?

Scrappers Team edited this page Dec 27, 2021 · 8 revisions

Welcome to the Arithmos wiki!

This section would show you how to build Arithmos from sources and add your arithmetic and algorithmic code. ENJOY !

1) Fork and Clone :

  • Fork from github fork.
  • Navigate to your desired directory of project cd your-directory.
  • Clone from command line using :
gh repo clone Scrappers-glitch/Arithmos

2) Do your changes :

  • To add your java-code use the code/java/src/ directory and add only one package then your code inside.
  • To add your native code C/C++ use the code/natives/includes for headers .h files and /libs for .c .cxx and .cpp files.
  • Find the books in readme for Algorithms/Data Structures, Java, Natives and Bash.

3) Do a PR :

  • Use these commands :
# create a new branch
git checkout -b alpha-update
# add some files to the upcoming commit
git add .
# commit to the branch
git commit -m 'Your commit message !'
# push the commit to the branch
git push --set-upstream https://github.com/**?username=**/Arithmos.git alpha-update
Username for 'https://github.com': 
Password for 'https://[email protected]@github.com': **ACCESS_TOCKEN**

Notes : -> Make sure to replace **?username=** with your github user name and **ACCESS_TOCKEN** with your git access tocken.

4) You can use Scala, Kotlin and Groovy as well as a replacement for Java and the sources got included as jar dependencies for the final jar (you cannot use call your java class in scala/kotlin/groovy for now, they are just dependencies for now).

To install kt/groovy/scala use SDKMAN sdk manager on gnu linux :

sdk install kotlin
sdk install groovy
sdk install scala
Clone this wiki locally