diff --git a/Docs/Abstractions.md.org b/Docs/Abstractions.org similarity index 95% rename from Docs/Abstractions.md.org rename to Docs/Abstractions.org index 2254b73..d0d8e6f 100644 --- a/Docs/Abstractions.md.org +++ b/Docs/Abstractions.org @@ -29,7 +29,7 @@ The Abstractions package consists of black-boxed functions for P2PRC. -------------- -*** Next Chapter: [[file:Implementation.md][Implementation]] +*** Next Chapter: [[file:Implementation.org][Implementation]] :PROPERTIES: :CUSTOM_ID: next-chapter-implementation :END: diff --git a/Docs/Bindings.md.org b/Docs/Bindings.org similarity index 100% rename from Docs/Bindings.md.org rename to Docs/Bindings.org diff --git a/Docs/CliImplementation.md.org b/Docs/CliImplementation.org similarity index 100% rename from Docs/CliImplementation.md.org rename to Docs/CliImplementation.org diff --git a/Docs/Client.md.org b/Docs/Client.org similarity index 100% rename from Docs/Client.md.org rename to Docs/Client.org diff --git a/Docs/ClientArchitecture.md.org b/Docs/ClientArchitecture.org similarity index 100% rename from Docs/ClientArchitecture.md.org rename to Docs/ClientArchitecture.org diff --git a/Docs/ClientImplementation.md.org b/Docs/ClientImplementation.org similarity index 93% rename from Docs/ClientImplementation.md.org rename to Docs/ClientImplementation.org index 2296f73..0300525 100644 --- a/Docs/ClientImplementation.md.org +++ b/Docs/ClientImplementation.org @@ -14,17 +14,6 @@ the IP tables from the previous servers. [[file:images/NumOfHops.png]] [[file:images/clientmoduleArch.png]] -** Topics -:PROPERTIES: -:CUSTOM_ID: topics -:END: -1. [[#updating-the-IP-table][Updating the IP table]] -2. [[#reading-server-specifications][Reading server specifications]] -3. [[#Client-creating-and-removing-container][Client creating and - removing container]] -4. [[#Tracking-Containers][Tracking Containers]] -5. [[#Grouping-Containers][Grouping Containers]] - This section focuses in depth on how the client module works. The client module is incharge of communicating with different servers based on the IP addresses provided to the user. The IP addresses are derived from diff --git a/Docs/ConfigImplementation.md.org b/Docs/ConfigImplementation.org similarity index 100% rename from Docs/ConfigImplementation.md.org rename to Docs/ConfigImplementation.org diff --git a/Docs/DesignArchtectureIntro.md.org b/Docs/DesignArchtectureIntro.org similarity index 100% rename from Docs/DesignArchtectureIntro.md.org rename to Docs/DesignArchtectureIntro.org diff --git a/Docs/DomainNameMappingsImplementation.md.org b/Docs/DomainNameMappingsImplementation.org similarity index 80% rename from Docs/DomainNameMappingsImplementation.md.org rename to Docs/DomainNameMappingsImplementation.org index 38aca3f..69f504a 100644 --- a/Docs/DomainNameMappingsImplementation.md.org +++ b/Docs/DomainNameMappingsImplementation.org @@ -2,4 +2,5 @@ :PROPERTIES: :CUSTOM_ID: domain-name-mappings :END: -This + +Todo be written. diff --git a/Docs/Implementation.md.org b/Docs/Implementation.md.org deleted file mode 100644 index f797bb8..0000000 --- a/Docs/Implementation.md.org +++ /dev/null @@ -1,66 +0,0 @@ -* Implementation -:PROPERTIES: -:CUSTOM_ID: implementation -:END: -| [[file:Introduction.md][◀ Previous]] | [[file:README.md][Back to TOC]] | -|--------------------------------------+---------------------------------| - -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 -:PROPERTIES: -:CUSTOM_ID: programming-langauge-used -:END: -The programming language used for this project was -[[https://go.dev/][Golang]]. 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 -[[https://git.sr.ht/~akilan1999/p2p-rendering-computation][git.sr.ht/~akilan1999/p2p-rendering-computation]]. - -- - ** [[file:CliImplementation.md][Cli Module]] - :PROPERTIES: - :CUSTOM_ID: cli-module - :END: - -- - ** [[file:ConfigImplementation.md][Config Module]] - :PROPERTIES: - :CUSTOM_ID: config-module - :END: - -- - ** [[file:ServerImplementation.md][Server Module]] - :PROPERTIES: - :CUSTOM_ID: server-module - :END: - -- - ** [[file:ClientImplementation.md][Client Module]] - :PROPERTIES: - :CUSTOM_ID: client-module - :END: - -- - ** [[file:P2PImplementation.md][P2P Module]] - :PROPERTIES: - :CUSTOM_ID: p2p-module - :END: - -- - ** [[file:PluginImplementation.md][Plugin Module]] - :PROPERTIES: - :CUSTOM_ID: plugin-module - :END: - -- - ** [[file:GenerateImplementation.md][Generate Module]] - :PROPERTIES: - :CUSTOM_ID: generate-module - :END: diff --git a/Docs/Implementation.org b/Docs/Implementation.org new file mode 100644 index 0000000..5c10ab2 --- /dev/null +++ b/Docs/Implementation.org @@ -0,0 +1,21 @@ +* Implementation +:PROPERTIES: +:CUSTOM_ID: implementation +:END +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 language used +:PROPERTIES: +:CUSTOM_ID: programming-langauge-used +:END: +The programming language used for this project was +[[https://go.dev/][Golang]]. 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 +[[https://git.sr.ht/~akilan1999/p2p-rendering-computation][git.sr.ht/~akilan1999/p2p-rendering-computation]]. diff --git a/Docs/Installation.md.org b/Docs/Installation.org similarity index 96% rename from Docs/Installation.md.org rename to Docs/Installation.org index 5258f75..27adec3 100644 --- a/Docs/Installation.md.org +++ b/Docs/Installation.org @@ -2,8 +2,6 @@ :PROPERTIES: :CUSTOM_ID: installation :END: -| [[file:Introduction.md][◀ Previous]] | [[file:Abstractions.md][Next ▶]] | -|--------------------------------------+----------------------------------| Over here we will cover the basic steps to get the server and client side running. @@ -351,11 +349,4 @@ This feature is still Under Development: Refer the section [[#install-docker][Install Docker]]. - =cd plugin= - =go test .= -#+end_quote - --------------- - -*** Next Chapter: [[file:Abstractions.md][Abstractions]] -:PROPERTIES: -:CUSTOM_ID: next-chapter-abstractions -:END: +#+end_quote \ No newline at end of file diff --git a/Docs/Introduction.md.org b/Docs/Introduction.org similarity index 85% rename from Docs/Introduction.md.org rename to Docs/Introduction.org index 5ded787..00b46d7 100644 --- a/Docs/Introduction.md.org +++ b/Docs/Introduction.org @@ -2,8 +2,6 @@ :PROPERTIES: :CUSTOM_ID: chapter-1-introduction :END: -| [[file:README.md][◀ Back to TOC]] | [[file:Installation.md][Next ▶]] | -|-----------------------------------+----------------------------------| ** Abstract :PROPERTIES: @@ -38,11 +36,4 @@ useful. Ethically speaking this is leading to monopolisation of computing power similar to what is happening in the web server area. By using peer to peer principles it is possible to remove the monopolisation factor and increase the bandwidth between the client and -server. - --------------- - -*** Next Chapter: [[file:Installation.md][Installation]] -:PROPERTIES: -:CUSTOM_ID: next-chapter-installation -:END: +server. \ No newline at end of file diff --git a/Docs/NAT-Traveral.md.org b/Docs/NAT-Traveral.org similarity index 100% rename from Docs/NAT-Traveral.md.org rename to Docs/NAT-Traveral.org diff --git a/Docs/P2P-testing.md.org b/Docs/P2P-testing.org similarity index 100% rename from Docs/P2P-testing.md.org rename to Docs/P2P-testing.org diff --git a/Docs/P2P.md.org b/Docs/P2P.org similarity index 100% rename from Docs/P2P.md.org rename to Docs/P2P.org diff --git a/Docs/P2PArchitecture.md.org b/Docs/P2PArchitecture.org similarity index 100% rename from Docs/P2PArchitecture.md.org rename to Docs/P2PArchitecture.org diff --git a/Docs/P2PImplementation.md.org b/Docs/P2PImplementation.org similarity index 100% rename from Docs/P2PImplementation.md.org rename to Docs/P2PImplementation.org diff --git a/Docs/PluginImplementation.md.org b/Docs/PluginImplementation.org similarity index 94% rename from Docs/PluginImplementation.md.org rename to Docs/PluginImplementation.org index cca9688..fb456a0 100644 --- a/Docs/PluginImplementation.md.org +++ b/Docs/PluginImplementation.org @@ -2,16 +2,6 @@ :PROPERTIES: :CUSTOM_ID: plugin-module-implementation :END: -** Topics -:PROPERTIES: -:CUSTOM_ID: topics -:END: -1. [[#introduction][Introduciton]] -2. [[#site-File-Template][Site.yml]] -3. [[#hosts-file][Host]] -4. [[#description-file][Description]] -5. [[#automatic-port-allocations][Automatic port allocations]] -6. [[#sample-plugins-implemented][Sample plugins implemented]] ** Introduction :PROPERTIES: diff --git a/Docs/README.md.org b/Docs/README.md.org deleted file mode 100644 index 1659f36..0000000 --- a/Docs/README.md.org +++ /dev/null @@ -1,18 +0,0 @@ -* Table of contents -:PROPERTIES: -:CUSTOM_ID: table-of-contents -:END: -1. [[file:Introduction.md][Introduction]] -2. [[file:Installation.md][Installation]] -3. [[file:Abstractions.md][Abstractions]] -4. [[file:Implementation.md][Implementation]] - 1. [[file:ClientImplementation.md][Client Module]] - 2. [[file:P2PImplementation.md][P2P Module]] - 3. [[file:ServerImplementation.md][Server Module]] - 4. [[file:ConfigImplementation.md][Config Module]] - 5. [[file:CliImplementation.md][Cli Module]] - 6. [[file:PluginImplementation.md][Plugin Module]] - 7. [[file:Bindings.md][Language bindings]] - 8. [[file:Bindings.md][Domain name mappings]] -5. Language bindings - 1. [[file:haskell/][Haskell]] diff --git a/Docs/README.org b/Docs/README.org new file mode 100644 index 0000000..ebe24e0 --- /dev/null +++ b/Docs/README.org @@ -0,0 +1,18 @@ +* Table of contents +:PROPERTIES: +:CUSTOM_ID: table-of-contents +:END: +1.[[file:Introduction.org][ Introduction]] +2. [[file:Installation.org][Installation]] +3. [[file:Abstractions.org][Abstractions]] +4. [[file:Implementation.org][Implementation]] + 1. [[file:ClientImplementation.org][Client Module]] + 2. [[file:P2PImplementation.org][P2P Module]] + 3. [[file:ServerImplementation.org][Server Module]] + 4. [[file:ConfigImplementation.org][Config Module]] + 5. [[file:CliImplementation.org][Cli Module]] + 6. [[file:PluginImplementation.org][Plugin Module]] + 7. [[file:Bindings.org][Language bindings]] + 8. [[file:Bindings.org][Domain name mappings]] +5. Language bindings + 1. [[file:haskell/][Haskell]]