me/p2p-rendering-computation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #100 from cr2007/master

Browse Source 
Polishes up the Documentation
This commit is contained in:
Akilan Selvacoumar
2023-07-06 15:39:38 +01:00
committed by GitHub
parent 8f4c2623e3 70aa82a946
commit 232c13aca0
4 changed files with 43 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
Docs/Abstractions.md
View File

@@ -1,6 +1,14 @@
# Abstractions # Abstractions
| [◀ Previous](Installation.md) | [Next ▶](Implementation.md) |
|:-----------:|---------|
The Abstractions package consists of black-boxed functions for P2PRC. The Abstractions package consists of black-boxed functions for P2PRC.
## Functions ## Functions
- ```Init(<Project name>)```: Initializes P2PRC with all the needed configurations. - ```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)

29
Docs/Implementation.md
View File

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

20
Docs/Installation.md
View File

@@ -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. 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 .\install.bat
``` ```
### Add appropriate paths to .bashrc ### Add appropriate paths to `.bashrc`
``` ```
export P2PRC=/<PATH>/p2p-rendering-computation export P2PRC=/<PATH>/p2p-rendering-computation
export PATH=/<PATH>/p2p-rendering-computation:${PATH} export PATH=/<PATH>/p2p-rendering-computation:${PATH}
@@ -111,7 +114,7 @@ GLOBAL OPTIONS:
# Using basic commands # Using basic commands
### Start as a server ### Start as a server
Do ensure you have docker installed for this Do ensure you have Docker installed for this
``` ```
p2prc -s p2prc -s
``` ```
@@ -223,14 +226,13 @@ This feature is still Under Development:
#### Run Test Cases #### Run Test Cases
- Generate Test Case Ansible file - Generate Test Case Ansible file
- ```make testcases``` - ```make testcases```
- Enter inside plugin directory and run tests. - Enter inside plugin directory and run tests.<br>
Note: That docker needs to installed and needs to run without **Note:** That docker needs to installed and needs to run without
sudo. Refer the section install Docker. sudo. Refer the section [Install Docker](#install-docker).
- ```cd plugin``` - ```cd plugin```
- ```go test .``` - ```go test .```
---
### Next Chapter: [Abstractions](Abstractions.md)

7
Docs/Introduction.md
View File

@@ -1,5 +1,8 @@
# Chapter 1: Introduction # Chapter 1: Introduction
| [◀ Back to TOC](README.md) | [Next ▶](Installation.md) |
|:-----------:|---------|
## Abstract ## Abstract
This project focuses on creating a framework on running heavy tasks that a regular computer 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 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 - Creating p2p network
- Server to create a containerised environment - Server to create a containerised environment
- The client node to run tasks on Server containerised node --> - The client node to run tasks on Server containerised node -->
---
### Next Chapter: [Installation](Installation.md)