diff --git a/Docs/Abstractions.md b/Docs/Abstractions.md index eaa6cbf..9817ec2 100644 --- a/Docs/Abstractions.md +++ b/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()```: 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. \ No newline at end of file +- ```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) \ No newline at end of file diff --git a/Docs/Implementation.md b/Docs/Implementation.md index 9a45341..b215d0a 100644 --- a/Docs/Implementation.md +++ b/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.
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.
+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) \ No newline at end of file +- ## [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) \ No newline at end of file diff --git a/Docs/Installation.md b/Docs/Installation.md index 53a2427..a0e568f 100644 --- a/Docs/Installation.md +++ b/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=//p2p-rendering-computation export 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.
+ **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) diff --git a/Docs/Introduction.md b/Docs/Introduction.md index 8977ca5..0a5b5de 100644 --- a/Docs/Introduction.md +++ b/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) \ No newline at end of file