Skip to content

Contributing and Project Structure

shermand100 edited this page Jan 23, 2024 · 4 revisions

How is this project constructed? / Why all these github branches?

This page aims to give an insight into how this project manages it's branches and file structure.

This project can look daunting but I assure you it's not.

View images in new tab to view text/zoom.

Master holds our highest level variables that PiNodeXMR devices reach out to for updates. Things like the Monero project github release number (release_v0.18), latest PiNodeXMR, Monero, BlockExplorer or P2Pool version numbers. This allows me as the project manager to update these values when required so your device can compare against them to see if you can update. Master branch is used because these values are applicable to all PiNodeXMR devices, regardless of what OS the project is based on. There are then a few images on this branch for the purposes of hosting for the wiki or user support.

Things have recently changed. We now only use the Master branch, and the Repo is now held on my personal GitHub account "shermand100". When viewing the images below some still have the old links, but operation is the same.

So how does PiNodeXMR Install itself?

A user should install the latest Ubuntu LTS server image for their device (single board computer, or AMD64 device - laptop/desktop) Then when wget -O – install.pinodexmr.co.uk | bash is run, the following happens...

PiNodeXMR Install process

When I click a "Start Node" button, what's going on?

Start Node Process

When I select update Monero from the terminal Menu, what's happening?

Update Monero