Merge pull request #83 from Gaurav-Gosain/master
Adds CI/CD workflow for website generation from the README Documentation
This commit is contained in:
Akilan Selvacoumar
49
.github/workflows/pages.yml
vendored
Normal file
49
.github/workflows/pages.yml
vendored
Normal file
@@ -0,0 +1,49 @@
|
||||
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
|
||||
|
||||
on:
|
||||
# Runs on pushes targeting the default branch
|
||||
push:
|
||||
branches: ["main", "master"]
|
||||
|
||||
# Allows you to run this workflow manually from the Actions tab
|
||||
workflow_dispatch:
|
||||
|
||||
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
|
||||
permissions:
|
||||
contents: read
|
||||
pages: write
|
||||
id-token: write
|
||||
|
||||
# Allow one concurrent deployment
|
||||
concurrency:
|
||||
group: "pages"
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
# Build job
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
- name: Setup Pages
|
||||
uses: actions/configure-pages@v2
|
||||
- name: Build with Jekyll
|
||||
uses: actions/jekyll-build-pages@v1
|
||||
with:
|
||||
source: ./
|
||||
destination: ./_site
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v1
|
||||
|
||||
# Deployment job
|
||||
deploy:
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
steps:
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v1
|
||||
23
README.md
23
README.md
@@ -6,11 +6,12 @@
|
||||
|
||||
<!-- seperator -->
|
||||
|
||||
|
||||
[](http://perso.crans.org/besson/LICENSE.html)
|
||||
[](https://GitHub.com/Akilan1999/p2p-rendering-computation/graphs/commit-activity)
|
||||
[](http://golang.org)
|
||||
[](https://pkg.go.dev/git.sr.ht/~akilan1999/p2p-rendering-computation)
|
||||
<div style="display:flex;flex-wrap:wrap;">
|
||||
<a href="http://perso.crans.org/besson/LICENSE.html"><img alt="GPLv2 license" src="https://img.shields.io/badge/License-GPLv2-blue.svg" style="padding:5px;margin:5px;" /></a>
|
||||
<a href="https://GitHub.com/Akilan1999/p2p-rendering-computation/graphs/commit-activity"><img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" style="padding:5px;margin:5px;" /></a>
|
||||
<a href="http://golang.org"><img alt="made-with-Go" src="https://img.shields.io/badge/Made%20with-Go-1f425f.svg" style="padding:5px;margin:5px;" /></a>
|
||||
<a href="https://pkg.go.dev/git.sr.ht/~akilan1999/p2p-rendering-computation"><img alt="GoDoc reference example" src="https://img.shields.io/badge/godoc-reference-blue.svg" style="padding:5px;margin:5px;" /></a>
|
||||
</div>
|
||||
|
||||
The main aim of this project was to create a custom peer to peer network. The user acting as the
|
||||
client has total flexibility on how to batch the tasks and the user acting as the server has complete
|
||||
@@ -61,11 +62,11 @@ This project aims to create a peer to peer (p2p) network, where a user can use t
|
||||
make install
|
||||
```
|
||||
- If you look closely you will get outputs such as:
|
||||
|
||||
// Add them to your .bashrc file
|
||||
export P2PRC=/<path>/p2p-rendering-computation
|
||||
export PATH=/<path>/p2p-rendering-computation:${PATH}
|
||||
|
||||
```
|
||||
// Add them to your .bashrc file
|
||||
export P2PRC=/<path>/p2p-rendering-computation
|
||||
export PATH=/<path>/p2p-rendering-computation:${PATH}
|
||||
```
|
||||
|
||||
5. Test if it works
|
||||
```
|
||||
@@ -98,4 +99,4 @@ As we are working on the open source project p2prc (i.e p2p network designed fo
|
||||
or just providing feedback on new features to build or even just curious about new features added to the project. We have decided to create a discord group.
|
||||
[](https://discord.gg/b4nRGTjYqy)
|
||||
|
||||
|
||||
[](https://github.com/Gaurav-Gosain)
|
||||
|
||||
9
_config.yml
Normal file
9
_config.yml
Normal file
@@ -0,0 +1,9 @@
|
||||
remote_theme: abhinavs/moonwalk
|
||||
|
||||
favicon: "favicon-32x32.png" # relative path to site's favicon
|
||||
|
||||
theme_config:
|
||||
appearance: "dark" # can be "light", "dark" or "auto"
|
||||
appearance_toggle: true # if appearance can be switched by user
|
||||
show_navbar: false
|
||||
show_footer: false
|
||||
58
index.html
58
index.html
@@ -1,58 +0,0 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>P2PRC</title>
|
||||
<link rel="stylesheet" href="style.css"></link>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<img src="Docs/images/p2prclogo.png" alt="P2PRC Logo">
|
||||
<h1>P2PRC</h1>
|
||||
<b>A peer to peer network designed for computation</b>
|
||||
|
||||
<p><dfn>P2PRC</dfn> is peer to peer to network designed for computation reasons.</p>
|
||||
<p>This project was developed during my 4th year dissertation at Heriot-Watt University and We are getting the project to a usable state.</p>
|
||||
<p> It's purpose is for people to use each others computers rather than servers such as <abbr title="Amazon Web Services">AWS</abbr> and <span title="Microsoft Azure">Azure</span>.</p>
|
||||
|
||||
<p><b>Project:</b></p>
|
||||
<ul>
|
||||
<li>
|
||||
<a href="https://github.com/Akilan1999/p2p-rendering-computation" target="_blank">P2PRC on GitHub</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="https://discord.gg/b4nRGTjYqy" target="_blank">P2PRC Discord Server</a> <span id="discordJoin">(join here to chat!)</span>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p><b>Community Server to download public network</b></p>
|
||||
<ul>
|
||||
<li>
|
||||
<b>Only for v1.0.0</b>
|
||||
<br>
|
||||
<!-- <b>IP Address: 172.104.44.195</b>-->
|
||||
<p>Use this server to only download part of the p2p network</p>
|
||||
</li>
|
||||
<li>
|
||||
<b>Master branch</b>
|
||||
<br>
|
||||
<!-- <b>IP Address: 139.162.246.221</b>-->
|
||||
<p>Use this server to only download part of the p2p network</p>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p><b>Main developer:</b></p>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<b><a href="https://akilan.io" target="_blank"><span title="The Not So Boring Developer">Akilan Selvacoumar</span></a></b>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<p><b>Other links:</b></p>
|
||||
<ul>
|
||||
<li><a href="https://www.youtube.com/channel/UChy18QB1hBzZ7MniIW_FJvQ" target="_blank">Akilan Selvacoumar on YouTube</a></li>
|
||||
<li><a href="https://akilan.io/projects/p2prc/" target="_blank">Project info from akilan.io</a></li>
|
||||
</ul>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user