Ecosystem/gupaxx
1
0
Fork 0
mirror of https://github.com/Cyrix126/gupaxx.git synced 2025-04-23 23:08:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

some formatting improvements

Browse source
This commit is contained in:
cheese 2024-12-12 15:28:06 +01:00
parent 07ac351764
commit 32da961fd7
1 changed files with 22 additions and 23 deletions

45
README.md
View file

@ -1,11 +1,11 @@
![Gupaxx logo](assets/images/banner.png)
## Development Status
This fork has a stable release.
This fork has a stable release.
It is intended for end users and offers a friendly and easy user experience.
## Gupaxx
`Gupaxx` is a fork of [**Gupax**](https://github.com/hinto-janai/gupax) integrating the [XMRvsBeast Raffle](https://xmrvsbeast.com), it is also a maintained software. Designed to simplify mining on [P2Pool](https://www.getmonero.org/2021/10/05/p2pool-released.html) while optionally participating (but you will want to 😉) in the XMRvsBeast raffle.
`Gupaxx` is a fork of [**Gupax**](https://github.com/hinto-janai/gupax) integrating the [XMRvsBeast Raffle](https://xmrvsbeast.com), it is also a maintained software. Designed to simplify mining on [P2Pool](https://www.getmonero.org/2021/10/05/p2pool-released.html) while optionally participating (but you will want to 😉) in the XMRvsBeast raffle.
## System requirements
`Gupaxx` may not run on machines with:
@ -15,15 +15,15 @@ It is intended for end users and offers a friendly and easy user experience.
[![CI](https://github.com/cyrix126/gupaxx/actions/workflows/ci.yml/badge.svg)](https://github.com/cyrix126/gupaxx/actions/workflows/ci.yml)
## Contents
* [What is Gupaxx/XMRvsBeast?](#what-is-gupaxxxmrvsbeast)
* [Guide](#guide)
* [XvB Tab](#xvb-tab)
- [Console](#console-of-xvb)
- [Token Input](#token-input)
- [Account stats](#account-stats)
* [XvB Raffle](#xvb-raffle-status)
* [Other changes](#other-changes)
* [License](#license)
* [What is Gupaxx/XMRvsBeast?](#what-is-gupaxxxmrvsbeast)
* [Guide](#guide)
* [XvB Tab](#xvb-tab)
- [Console](#console-of-xvb)
- [Token Input](#token-input)
- [Account stats](#account-stats)
* [XvB Raffle](#xvb-raffle-status)
* [Other changes](#other-changes)
* [License](#license)
## What is Gupaxx/XMRvsBeast?
[**`Gupaxx`**](https://getmonero.org) is a fork of [*Gupax*](https://github.com/hinto-janai/gupax) that integrates the [XMRvsBeast raffle](https://xmrvsbeast.com).
@ -43,17 +43,16 @@ Next steps can be seen in this video tutorial:
https://github.com/Cyrix126/gupaxx/assets/58007246/610cbfea-fd97-4150-95ed-9c8a7ef5ba94
4. Input your Monero address in the `P2Pool` tab
5. Register the same address on [XMRvsBeast](https://xmrvsbeast.com)
6. Input the token received in the XvB Tab
6. Start P2Pool
7. Start XMRig
8. Start XvB
6. Input the token received in the `XvB` Tab
6. Start `P2Pool`
7. Start `XMRig`
8. Start `XvB`
Gupaxx will distribute your hashrate between P2Pool and XMRvsBeast as defined by [this algorithm](NOTES_ALGORITHM.md).
The algorithm will decide which quantity of HR that will be directed to P2Pool and to XMRvsBeast, so that you still keep a share in the [PPLNS Window](https://github.com/SChernykh/p2pool#how-payouts-work-in-p2pool).
The algorithm will decide which quantity of HR that will be directed to P2Pool and to XMRvsBeast, so that you still keep a share in the [PPLNS Window](https://github.com/SChernykh/p2pool#how-payouts-work-in-p2pool).
It will by default send just enough to get to the highest round or, if hero mode is enabled, everything minus the minimum required to still have a share in the PPLNS Window.
</div>
@ -68,7 +67,7 @@ Account stats about your address on XMRvsBeast can be found here after the proce
## XvB Raffle Status
Gupaxx adds a new column called **XvB Raffle** on the Status Tab in the Process submenu. It displays public statistics of XMRvsBeast, which are available [here](https://xmrvsbeast.com/p2pool).
Gupaxx adds a new column called **XvB Raffle** on the Status Tab in the Process submenu. It displays public statistics of XMRvsBeast, which are available [here](https://xmrvsbeast.com/p2pool).
It is refreshed every minute.
This column will be active if the XvB process is started even partially, it doesn't need the token to be provided.
@ -76,9 +75,9 @@ This column will be active if the XvB process is started even partially, it does
## Other changes
This fork brings upgrades of dependence and some bugfixes about visual, performance and security that you can find in [DIFFERENCES](DIFFERENCES.md).
~~I will eventually (meaning when I'll have time) create pull requests for upstream about these differences.~~
**Edit**:
This fork brings upgrades of dependence and some bugfixes about visual, performance and security that you can find in [DIFFERENCES](DIFFERENCES.md).
~~I will eventually (meaning when I'll have time) create pull requests for upstream about these differences.~~
**Edit**:
There is currently no plan to upstream the changes as the owner of Gupax said he won't have time to review the PR.
@ -87,8 +86,8 @@ If you have any issue, feel free to ask for support in the [xmrvsbeast matrix ro
### Windows
You must add an exception to your antivirus for the directory where Gupaxx is executed. Follow the step for Windows Only, that starts at 30 seconds in this [video](https://user-images.githubusercontent.com/101352116/207978455-6ffdc0cc-204c-4594-9a2f-e10c505745bc.mp4).
### Mac OSX
You must remove Gupaxx app from quarantine with following command:
*If you have put Gupaxx.app in your Applications*
You must remove Gupaxx app from quarantine with following command:
*If you have put Gupaxx.app in your Applications*
`xattr -d com.apple.quarantine /Applications/Gupaxx.app`
See this [issue](https://github.com/hinto-janai/gupax/issues/51).