diff --git a/_includes/_guides/_boinc_introduction.htm b/_includes/_guides/_boinc_introduction.htm new file mode 100644 index 0000000..ee93ae8 --- /dev/null +++ b/_includes/_guides/_boinc_introduction.htm @@ -0,0 +1,25 @@ +
+

+ + BOINC Introduction +

+ + BOINC logo + +

+ BOINC—The Berkeley Open + Infrastructure for Network Computing, an open-source middleware + system, supports volunteer and grid computing. Originally developed to + support the SETI@home project, it became generalized as a platform for + other distributed applications in areas as diverse as mathematics, + linguistics, medicine, molecular biology, climatology, environmental + science, and astrophysics, among others. BOINC aims to enable researchers + to tap into the enormous processing resources of multiple personal + computers around the world. +

+

+ Don't want BOINC rewards? Switch to the Staking-only Guide. + You do not need to install or run BOINC in order to use GRC as a + cryptocurrency. +

+
\ No newline at end of file diff --git a/_includes/_guides/_pool_crunching.htm b/_includes/_guides/_pool_crunching.htm new file mode 100644 index 0000000..d33bc15 --- /dev/null +++ b/_includes/_guides/_pool_crunching.htm @@ -0,0 +1,135 @@ +{% include _guides/_boinc_introduction.htm %} + +
+

+ + Step-by-Step Guide +

+ +
+
+
+ +

+ + Step 1. Install BOINC +

+
+
+

+ You must install the BOINC client and select one or more BOINC + projects. Go to the BOINC + website, download and install BOINC for any computer that + you want to run BOINC on. The BOINC+VirtualBox package is + only needed if you choose projects that use VirtualBox. +

+
+
+ +
+
+ +

+ + Step 2. Sign up to a Gridcoin pool +

+
+
+

+ There are currently two pools: +

+ GRCPOOL has created several video tutorials for new users: + +

+
+
+ +
+
+ +

+ + Step 2. Choose Projects +

+
+
+

+ To earn Gridcoin, you need to crunch + whitelisted BOINC projects. +

+

Project Selection Tips

+
    +
  • + Choose projects with the least competition. Use + GridcoinStats to + help identify such projects. +
    • +
  • + Select projects most compatible with your computer hardware. + Don't crunch GPU work with a CPU. +
    • +
  • + Verify that your projects have enough work available. You + don't want downtime while waiting for projects to generate + new work. +
    • +
  • + Have a backup project in case your primary project runs out + of work or goes down. +
    • +
+
+
+ +
+
+ +

+ + Step 4. Install the Gridcoin Wallet +

+
+
+

+ Install a client compatible with your operating system. +

+
+
+ +
+
+ +

+ + Step 5. Sync with the Blockchain +

+
+
+

+ Before your wallet can do anything, it needs to be synced + (the green check mark under connections means you are synced). +

+
+
+ +
+
+ +

+ + Step 7. Earn Research Rewards +

+
+
+ Follow the instructions provided by the selected gridcoin pool. +
+
+
+
diff --git a/_includes/_guides/_solo_crunching.htm b/_includes/_guides/_solo_crunching.htm new file mode 100644 index 0000000..fde0451 --- /dev/null +++ b/_includes/_guides/_solo_crunching.htm @@ -0,0 +1,272 @@ +{% include _guides/_boinc_introduction.htm %} + +
+

+ + Step-by-Step Guide +

+ +
+
+
+ +

+ + Step 1. Install BOINC +

+
+
+

+ You must install the BOINC client and select one or more BOINC + projects. Go to the BOINC + website, download and install BOINC for any computer that + you want to run BOINC on. The BOINC+VirtualBox package is + only needed if you choose projects that use VirtualBox +

+
+
+ +
+
+ +

+ + Step 2. Choose Projects +

+
+
+

+ To earn Gridcoin, you need to crunch + whitelisted BOINC projects. +

+

Project Selection Tips

+
    +
  • + Choose projects with the least competition. Use + GridcoinStats to + help identify such projects. +
    • +
  • + Select projects most compatible with your computer hardware. + Don't crunch GPU work with a CPU. +
    • +
  • + Verify that your projects have enough work available. You + don't want downtime while waiting for projects to generate + new work. +
    • +
  • + Have a backup project in case your primary project runs out + of work or goes down. +
    • +
+
+
+ +
+
+ +

+ + Step 3. Setup Projects +

+
+
+

No Account Manager Setup

+
    +
  1. After starting BOINC, select the "add a project" button.
    2. +
  2. After clicking "Next", choose a project.
    3. +
  3. + For some projects (such as World Community Grid), you have to + register directly on the homepage of the project. Remember + to use the same email address for each BOINC project. +
    4. +
  4. + Confirm the registration. After tapping the "Finish" button, + a browser should open. If not, go to the project home page + (which can be found via a search engine). Find the "Your + Account" button and press it. +
    5. +
  5. + Within the web page, enter your username (country/post code + can be blank) and then press "OK". +
    6. +
  6. Repeat these steps for all projects that you want to participate in.
    7. +
+
+
+ +
+
+ +

+ + Step 4. Install the Gridcoin Wallet +

+
+
+

+ To earn Gridcoin in solo staking mode, you need to run the Gridcoin + client continuously. Install a client compatible with your operating + system. +

+ +

Optional Post-install Gridcoin Configuration

+ +
    +
  • + If you installed the BOINC client anywhere other than the + default installation location, you'll need to specify where + you installed BOINC in the gridcoinresearch.conf file. +
    • +
  • + You need to use the same email address for all BOINC projects. + Add this email to your gridcoinresearch.conf file (unless the + Gridcoin wizard has already done this for you). +
    • +
+
+
+ +
+
+ +

+ + Step 5. Sync with the Blockchain +

+
+
+

+ Before your wallet can do anything, it needs to be synced + (the green check mark under connections means you are synced). +

+
+
+ +
+
+ +

+ + Step 6. Get Some Gridcoin +

+
+
+

+ In Gridcoin's Proof-of-Stake (PoS) system, BOINC rewards are + given when users stake along with an additional 10 GRC. +

+

+ To stake and earn your BOINC rewards, a balance of GRC is + required. +

+ +
    +
  1. + For monthly staking, a balance of approximately 5000 GRC + is recommended. +
    2. +
  2. + The rate you are rewarded for your BOINC work is the rate + you mint PoS blocks because BOINC rewards are layered on + top of these blocks. +
    3. +
  3. + Your balance does not affect the amount of the payout, + only how frequent. You need to wait around 16 hours for + received coins to become eligible to earn staking rewards. +
    4. +
+ +

+ If you don't want to buy any Gridcoin, you can get some through + the faucets or through pool mining. + On most exchanges, you need to buy Bitcoin first in order to + buy Gridcoin. +

+
+
+ +
+
+ +

+ + Step 7. Earn Research Rewards +

+
+
+

Check Your Projects

+
    +
  1. + Make sure any projects you crunch are on the + whitelist. If a project + isn't approved, you will not be rewarded for it. +
    2. +
  2. + Check that the CPIDs (cross-project identifiers) are the + same across your projects. You can check on each project + or check using + BOINCstats. + If you found differing CPIDs, use this + guide. +
    3. +
  3. + If you installed the BOINC client anywhere other than the + default installation location, you'll need to specify + where you installed BOINC in the gridcoinresearch.conf file. +
    +
    + Windows: (Note the double backslashes are necessary. Change location according to your non-default install location) + 
    boincdatadir=D:\\ProgramData\\BOINC\\
+boincappdir=C:\\Program Files\\BOINC\\
    +
    + Linux: + 
    boincdatadir=/var/lib/boinc-client/
    +
    4. +
+ +

Configure the Wallet

+
    +
  1. + In the wallet, go to the "overview" page and check the + badge in the top-left. Make sure it doesn't say + "Staking Only". + +
      +
    • + If it does, ensure that you followed each + of the steps in "Check Your Projects" above. + If you set up BOINC in a non-default path, add + the path to the configuration file (see Step 4). +
      • +
    +
    2. +
  2. + Send a beacon. +
    3. +
+ +

Running the Wallet to Stake

+
    +
  1. + Unlock the wallet for staking only if locked. It is + recommended to have it encrypted for security. +
    2. +
  2. + Run the wallet close to 24/7. When your wallet is off, + you miss chances to stake blocks and earn rewards. +
    3. +
  3. + Every six months, you will need to send a beacon again. + Repeat the process shown in "Configure the Wallet". +
    4. +
  4. + Keep the wallet up-to-date as updates are released. +
    5. +
+
+
+
+
diff --git a/_includes/_guides/_staking_only.htm b/_includes/_guides/_staking_only.htm new file mode 100644 index 0000000..c961c92 --- /dev/null +++ b/_includes/_guides/_staking_only.htm @@ -0,0 +1,107 @@ +
+

+ + Step-by-Step Guide +

+ +
+
+
+ +

+ + Step 1. Install the Gridcoin Wallet +

+
+
+

+ To earn Gridcoin in solo staking mode, you need to run the Gridcoin + client continuously. Install a client compatible with your operating + system. +

+
+
+ +
+
+ +

+ + Step 2. Sync with the Blockchain +

+
+
+

+ Before your wallet can do anything, it needs to be synced + (the lit stacked icon on the bottom-right means you are synced). +

+
+
+ +
+
+ +

+ + Step 3. Get Some Gridcoin +

+
+
+

+ In Gridcoin's Proof-of-Stake (PoS) system, BOINC rewards are + given when users stake along with an additional 10 GRC. +

+

+ To stake, a balance of GRC is required. +

+ +
    +
  1. + For monthly staking, a balance of approximately 5000 GRC + is recommended. +
    2. +
  2. + Your balance does not affect the amount of the payout, + only how frequent. You need to wait around 16 hours for + received coins to become eligible to earn staking rewards. +
    3. +
+ +

+ If you don't want to buy any Gridcoin, you can get some through + the faucets or through pool mining. + On most exchanges, you need to buy Bitcoin first in order to + buy Gridcoin. +

+
+
+ +
+
+ +

+ + Step 4. Earn Gridcoin via POS +

+
+
+
    +
  1. + Once running an up-to-date fully synced client with a positive balance, + all that is required is for you to unlock your wallet for 'staking only'. +
    2. +
  2. + Once your wallet is unlocked, it will take up to 16 hours + for your coins to fully start staking. +
    3. +
  3. + Best practice is to continuously stake 24/7 if possible, + since you have an opportunity to stake each block + (even if your probability is low) and coin age is not considered + within the staking probability calculation. +
    4. +
+
+
+
+
diff --git a/assets/css/gridcoin.css b/assets/css/gridcoin.css index 0f8252c..119e8a8 100644 --- a/assets/css/gridcoin.css +++ b/assets/css/gridcoin.css @@ -37,6 +37,13 @@ ul, ol { padding-left: 1.5em; } +pre { + border: 1px solid #bbcddb; + border-radius: 0.5rem; + background-color: #e9edf1; + padding: 1rem; +} + @media (prefers-reduced-motion: reduce) { html { scroll-behavior: auto; @@ -564,6 +571,10 @@ footer { /* Guides Page */ +#section_choose_mode .display-list { + border-bottom: none; +} + #section_guides_intro { background-image: url("/assets/img/il-header-guides.svg"); background-size: contain; @@ -580,15 +591,13 @@ footer { #section_choose_mode li { width: 33%; - padding-bottom: 3%; - border-bottom: 3px solid #eceff3; } -#section_choose_mode li.active { +#section_choose_mode li a.active { border-bottom-color: var(--primary); } -#section_choose_mode li:not(.active):hover { +#section_choose_mode li a:not(.active):hover { border-bottom-color: var(--primary-light); } @@ -600,6 +609,8 @@ footer { text-align: center; font-weight: bold; text-decoration: none; + padding-bottom: 10%; + border-bottom: 3px solid #eceff3; } #section_choose_mode img { @@ -607,7 +618,7 @@ footer { margin: 0 auto; } -#section_choose_mode li.active a, +#section_choose_mode a.active, #section_choose_mode li:hover a { color: var(--text-dark); } @@ -1008,39 +1019,32 @@ footer { * Wiki */ .docs-container h2 { - font-size: 2rem; - font-weight: normal; + font-size: 2rem; + font-weight: normal; } .docs-container h3 { - font-size: 1.5rem; - font-weight: 600; + font-size: 1.5rem; + font-weight: 600; } .docs-menu > summary { - list-style: none; - padding: 0.5rem 0; - font-size: 1.2rem; + list-style: none; + padding: 0.5rem 0; + font-size: 1.2rem; } .docs-menu .nav-link { - padding: 0.3rem 0; + padding: 0.3rem 0; } .docs-menu .nav-link.active { - color: var(--text-dark); - font-weight: 600; + color: var(--text-dark); + font-weight: 600; } @media (max-width: 991.98px) { - .docs-menu { - text-align: center; - } -} - -.docs-container pre { - border: 1px solid #bbcddb; - border-radius: 0.5rem; - background-color: #e9edf1; - padding: 1rem; + .docs-menu { + text-align: center; + } } diff --git a/assets/js/gridcoin.js b/assets/js/gridcoin.js index aac1931..86347cc 100644 --- a/assets/js/gridcoin.js +++ b/assets/js/gridcoin.js @@ -24,10 +24,19 @@ function getLatestRelease() { }); } +function switchTabs() { + var hash = window.location.hash; + if(hash != '' || hash != undefined) { + $('.nav-tabs a[href="' + hash + '"]').tab('show'); + } +} + $(document).ready(function () { onScroll(); $(document).on("scroll", onScroll); $('[data-toggle="tooltip"]').tooltip() //Enabled bootstrap tooltips. getLatestRelease(); + + switchTabs(); }); diff --git a/guides/index.htm b/guides/index.htm index 3eb3578..36f1a5a 100644 --- a/guides/index.htm +++ b/guides/index.htm @@ -22,312 +22,36 @@

Staking-only is for people who do not wish to work on distributed computing projects, but want to earn GRC by securing the ledger.

-