| 2024-October-22 | Documentation Version 0.0.1 |
To save time, here are a few links that can help in finding the required resources for developing, building and testing Cataphract.
Nion Cataphract is a modular, cross-platform and easy-to-use shell written in Java. It has a modular design, providing sufficient APIs to develop applications alongside or on top of Cataphract.
This will guide the user to download the repository and build the source code.
⚠️ ATTENTION - This guide assumes that all the prerequisite software has been downloaded, installed and configured correctly and will not cover the same.
Clone the Cataphract repository from GitHub to your local machine by navigating to the preferred directory and running the following command in your preferred terminal:
ℹ️ INFORMATION - Usually, the GitHub repository has 2 branches: Main and Development. The Main repository contains code that is finalized and tested, whereas the Development If you want to download the latest code (which may be untested and/or incomplete), please clone from the Development branch.
git clone https://github.com/DAK404/Cataphract.git
Once cloned, the user will need to navigate into the directory by running the following command:
cd Cataphract
After navigating to the Cataphract directory, the directory structure should look like this:
- PROJECT_ROOT_DIR -
|
|-- .github/
|-- .vscode/
|-- docs/
|-- Source/
|-- Tools/
Now, the repository has been cloned from GitHub and is ready to be built on the user’s local system.
For more information on building and testing, please see –> INSERT PAGE HERE
This project has 2 levels of documentation available:
ℹ️ INFORMATION - This documentation provides an overview of the APIs, which means that the user can understand the structure without having to read through the implementation details.
The Developer Documentation contains just enough information to developers who would want to write their own code by utilizing the available APIs in Cataphract. It contains information regarding the public classes, fields, constructors and methods only.
ℹ️ INFORMATION - This documentation details the complete structure of the program where users who are interested in the implementation and inner workings.
The Internal Documentation contains full information to developers who would want to understand, improve and optimize the Cataphract code. It contains information regarding private, protected and public classes, fields, constructors and methods.