merged from master

CITATION.cff

@@ -5,5 +5,5 @@ authors:
     given-names: Akilan
 title: P2PRC
 license: "GPL-2.0"
-version: 1.0.0
-date-released: 2021-07-22
+version: 2.0.0
+date-released: 2023-06-08

Docs/Abstractions.md

@@ -1,6 +1,14 @@
 # Abstractions 
+
+| [◀ Previous](Installation.md) | [Next ▶](Implementation.md) |
+|:-----------:|---------|
+
 The Abstractions package consists of black-boxed functions for P2PRC.
 
 ## Functions
 - ```Init(<Project name>)```:  Initializes P2PRC with all the needed configurations. 
-- ```Start()```: Starts p2prc as a server and makes it possible to extend by adding other routes and functionality to P2PRC.
+- ```Start()```: Starts p2prc as a server and makes it possible to extend by adding other routes and functionality to P2PRC.
+
+---
+
+### Next Chapter: [Implementation](Implementation.md)

Docs/Implementation.md

@@ -1,20 +1,23 @@
-# Implementation 
+# Implementation
+| [◀ Previous](Introduction.md) | [Back to TOC](README.md) |
+|:-----------:|---------|
+
 This chapter describes how the project was built. It talks in depth of the implementation
 performed to give a better understanding of the project.
 
 ## Programming langauge used
-The programming language used for this project was Golang. The reason Go lang was chosen was
-because it is a compiled language.
+The programming language used for this project was [Golang](https://go.dev/). The reason Go lang was chosen was
+because it is a compiled language.<br>
 The entire codebase is just a single binary file. When
 distributing to other linux distributing the only requirement would be the binary file to run the
-code. It is easy to write independant modules and be monolithic at the sametime using Go. Using
-Go.mod makes it very easy to handle external libraries and modularise code. The go.mod name for
-the project is git.sr.ht/~akilan1999/p2p-rendering-computation.
+code. It is easy to write independant modules and be monolithic at the sametime using Go.<br>
+Using Go.mod makes it very easy to handle external libraries and modularise code. The go.mod name for
+the project is [git.sr.ht/~akilan1999/p2p-rendering-computation](https://git.sr.ht/~akilan1999/p2p-rendering-computation).
 
-## [Cli Module](CliImplementation.md)
-## [Config Module](ConfigImplementation.md)
-## [Server Module](ServerImplementation.md)
-## [Client Module](ClientImplementation.md)
-## [P2P Module](P2PImplementation.md)
-## [Plugin Module](PluginImplementation.md)
-## [Generate Module](GenerateImplementation.md)
+- ## [Cli Module](CliImplementation.md)
+- ## [Config Module](ConfigImplementation.md)
+- ## [Server Module](ServerImplementation.md)
+- ## [Client Module](ClientImplementation.md)
+- ## [P2P Module](P2PImplementation.md)
+- ## [Plugin Module](PluginImplementation.md)
+- ## [Generate Module](GenerateImplementation.md)

Docs/Installation.md

@@ -1,4 +1,7 @@
-# Installation 
+# Installation
+
+| [◀ Previous](Introduction.md) | [Next ▶](Abstractions.md) |
+|:-----------:|---------|
 
 Over here we will cover the basic steps to get the server and client side running. 
 
@@ -39,7 +42,7 @@ To set up P2PRC on Windows, simply run this batch file.
 .\install.bat
 ```
 
-### Add appropriate paths to .bashrc
+### Add appropriate paths to `.bashrc`
 ```
 export P2PRC=/<PATH>/p2p-rendering-computation
 export PATH=/<PATH>/p2p-rendering-computation:${PATH}
@@ -111,7 +114,7 @@ GLOBAL OPTIONS:
 # Using basic commands 
 
 ### Start as a server 
-Do ensure you have docker installed for this 
+Do ensure you have Docker installed for this 
 ```
 p2prc -s 
 ```
@@ -223,14 +226,13 @@ This feature is still Under Development:
 #### Run Test Cases 
 - Generate Test Case Ansible file 
   - ```make testcases```
-- Enter inside plugin directory and run tests. 
-  Note: That docker needs to installed and needs to run without 
-  sudo. Refer the section install Docker. 
+- Enter inside plugin directory and run tests.<br>
+  **Note:** That docker needs to installed and needs to run without 
+  sudo. Refer the section [Install Docker](#install-docker). 
   - ```cd plugin```
   - ```go test .```
-  
 
+---
   
-  
-
+### Next Chapter: [Abstractions](Abstractions.md)
 

Docs/Introduction.md

@@ -1,5 +1,8 @@
 # Chapter 1: Introduction
 
+| [◀ Back to TOC](README.md) | [Next ▶](Installation.md) |
+|:-----------:|---------|
+
 ## Abstract
 This project focuses on creating a framework on running heavy tasks that a regular computer
 cannot run easily such as graphically demanding video games, rendering 3D animations , protein
@@ -34,3 +37,7 @@ rendering tools and tools to batch any sort of tasks.
 - Creating p2p network
 - Server to create a containerised environment
 - The client node to run tasks on Server containerised node -->
+
+---
+
+### Next Chapter: [Installation](Installation.md)