Kojamp Man

This is Kojamp Man, a Java/Kotlin project manager tool!

Dependencies

To use this entire project, you'll need a few things on your machine, such as:

• Some kind of version control system (Git)

  To proceed with the following operations, you'll need to use some git commands. Git is required!

• GNU Compile Collection, aka GCC (see website)

  This will be necessary to compile some C files along the way.

• GNU Make (see website)

  In this project, you will see/generate a bunch of Makefiles, so... it will be necessary to have the GNU Make!

• Java, Javac and JVM by Oracle website

  Well... the project is based on Java Language, so... obviously you'll need the java dependencies such as the compiler, runner and the virtual machine.

• Kotlin and Kotlinc (see website)

  Kotlin Lang isn't used in the project's source code, but you'll manage Kotlin files, so... Kotlin compiler and runner can be usefull!

Note

I could have cited a link on how to download each project dependency, but the way to install may vary from one OS to another, so I decided to leave this part up to you! 😉

Get, compile and run

To get, compile and run the program at your machine you'll need to do the following steps:

1. Go to an accessible path at your computer:

Under the current conditions of the program, I recommend going to a path that is easy to remember and access (like Desktop), so you can modify/delete the program folder whenever you want.

Tip

If a directory called kojamp-man or kojamp already exists at your path, I recommend that you delete or rename it to avoid unexpected behavior 💿

2. Clone this repository:

Now that you are on a suitable path, you can clone this repository by opening the terminal at this mentioned path and cloning repo by typing this at your terminal:

git clone https://github.com/nasccped/kojamp-man

3. Go to the cloned repo:

Now, if you're still inside the terminal, you can go to the cloned repo by typing:

cd kojamp-man

4. Compile:

Within the cloned repo, we have some setupe file(s) at setup/ dir. You can compile them by the root Makefile.

To compile the program, you can run the Makefile by typing:

# it will generate the C files output
# you will need the MAKE GNU and gcc to compile it
make binary

And finally, to run the final product, just type:

bin/kojamp