Skip to content

Commit

Permalink
update documentation and version
Browse files Browse the repository at this point in the history
  • Loading branch information
luminousmining committed Mar 30, 2024
1 parent be59850 commit 984f295
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 46 deletions.
8 changes: 4 additions & 4 deletions HIVEOS.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
You must add luminousminer uses `custom miner` mode.

Create new `Flight Sheet`.
![New flight sheet](https://github.com/luminousmining/miner/tree/main/setup/install/create_flight_sheet.PNG)
[<img src="setup/install/create_flight_sheet.PNG">]([https://link-to-your-URL/])

Click on `Setup Miner Config`.
Add link of release `lumininosminer-X.X_hiveos.tar.gz` in field `URL`.
Replace `YOUR_WALLET` by your wallet.
Replace `YOUR_WORKERNAME` by your workername.
![Setup miner config](https://github.com/luminousmining/miner/tree/main/setup/install/add_custom_miner.PNG)
[<img src="setup/install/add_custom_miner.PNG">]([https://link-to-your-URL/])

Save and run your flight sheet.
Enjoy the miner is running!
![Running](https://github.com/luminousmining/miner/tree/main/setup/install/miner_running.PNG)
[<img src="setup/install/miner_running.PNG">]([https://link-to-your-URL/])

52 changes: 25 additions & 27 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,35 @@
# Roadmap

current version `v1.0`
current version `v1.0`
stable version `v0.2`

+ v0.x
- [x] GPU mining Nvidia
- [x] GPU mining AMD
- [x] os Windows
- [x] os Linux
- [x] os Hiveos
- [x] algo autolykos v2
- [x] algo ethash
- [x] algo etchash
- [x] algo progpow
- [x] algo progpowZ
- [x] algo evrprogpow
- [x] algo kawpow
- [x] algo firopow
- [x] option mining global
- [x] option mining by gpu
- [x] terminal display stats mining
- [x] http server (API)
- [x] write log in file
- [x] GPU mining Nvidia
- [x] GPU mining AMD
- [x] os Windows
- [x] os Linux
- [x] os Hiveos
- [x] algo autolykos v2
- [x] algo ethash
- [x] algo etchash
- [x] algo progpow
- [x] algo progpowZ
- [x] algo evrprogpow
- [x] algo kawpow
- [x] algo firopow
- [x] option mining global
- [x] option mining by gpu
- [x] terminal display stats mining
- [x] http server (API)
- [x] write log in file

+ v1.x
- [ ] algo ?? help us to define list
- [ ] profile smart mining
- [ ] profile ravenminer
- [ ] os RaveOS
- [ ] build by conan
- [ ] profile smart mining
- [ ] profile ravenminer
- [ ] os RaveOS
- [ ] build by conan

+ v2.x
- [ ] profile traiding

+ v3.x
- [ ] CPU mining
- [ ] profile traiding

26 changes: 13 additions & 13 deletions SMART_MINING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Smart Mining

## What is it ?

SmartMining is a protocol allowing you to switch coins during your mining session.
The server will send the best algorithm and associated jobs based on the listed coins.

SmartMining is a protocol allowing you to switch coins during your mining session.
The server will send the best algorithm and associated jobs based on the listed coins.
## Protocol
```
miner pool
Expand All @@ -15,7 +15,7 @@ miner pool
| <--- smart_mining.set_extra_nonce |
| |
```

`mining.subscribe`:
```json
{
Expand All @@ -33,12 +33,12 @@ miner pool
]
}
```
`COIN_TAG` -> `string`: name of coin, examples CLORE, FIRO,...
`POOL_HOST` -> `string`: pool host, examples "clore.2miners.com", "pool.eu.woolypooly.com",...
`POOL_PORT` -> `integer`: pool port, examples 2020,3126,...
`YOUR_WALLET` -> `string`: your wallet linked to `COIN_TAG`.
**COIN_TAG** -> `string`: name of coin, examples CLORE, FIRO,...
**POOL_HOST** -> `string`: pool host, examples "clore.2miners.com", "pool.eu.woolypooly.com",...
**POOL_PORT** -> `integer`: pool port, examples 2020,3126,...
**YOUR_WALLET** -> `string`: your wallet linked to `COIN_TAG`.



`smart_mining.set_algo`:
```json
{
Expand All @@ -47,7 +47,7 @@ miner pool
"params": "ALGORITHM"
}
```
`ALGORITHM` -> name of algorithm, example kawpow, ethash,...
**ALGORITHM** -> `string` name of algorithm, example kawpow, ethash,...


`smart_mining.set_extra_nonce`:
Expand All @@ -58,5 +58,5 @@ miner pool
"params": PARAMS_EXTRA_NONCE
}
```
`PARAMS_EXTRA_NONCE` -> array or integer
**PARAMS_EXTRA_NONCE** -> `array` or `integer` contains the extraNonce(s)

4 changes: 2 additions & 2 deletions miner/sources/common/app.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@

namespace common
{
constexpr uint8_t VERSION_MAJOR{ 0 };
constexpr uint8_t VERSION_MINOR{ 2 };
constexpr uint8_t VERSION_MAJOR{ 1 };
constexpr uint8_t VERSION_MINOR{ 0 };
}

0 comments on commit 984f295

Please sign in to comment.