# Welcome

!!!
This documentation was partially generated with AI augmentation. Report inconsistencies at [github.com/warthog-network/docs/issues](https://github.com/warthog-network/docs/issues).
!!!

Warthog is an experimental cryptocurrency with world's first Proof of Balanced Work algorithm written by a group of crypto enthusiasts. It is meant to be a community effort and everyone is more than welcome to join and contribute. Who knows how big this project will be? This project is not a dumb fork of something else. It was developed completely from scratch!

Warthog's *Janushash* mining algorithm is unique across the crypto space, it is the world's first [Proof of Balanced Work (PoBW) algorithm](https://github.com/CoinFuMasterShifu/ProofOfBalancedWork/blob/main/PoBW.pdf), which requires CPU and GPU hash power for mining.

The [core repository](https://github.com/warthog-network) offers two applications:
* Node
* Command line Wallet

Furthermore there are two third-party wallets:
* [Wart-dapp](https://github.com/warthog-network/wart-dapp) (open source)
* [wart-wallet](https://github.com/warthog-network/wart-wallet) (open source)

Additionally, the project provides first-party wallets: **Wartlock** (desktop, Electron, mainnet) at https://github.com/warthog-network/Wartlock, **browser-wallet** (browser extension, *in development*, testnet) at https://github.com/warthog-network/browser-wallet, and **mobile-wallet** (React Native, *in development*, testnet) at https://github.com/warthog-network/mobile-wallet.

You can join the Warthog community on [Discord](https://discord.com/invite/QMDV8bGTdQ).

## Starting a node

Doc available here :
- [wart-node](guides/node/node.md)

## Using a wallet :

Doc available here :
- [wart-dapp (GUI)](guides/wallet/wart-dapp.md)
- [wart-wallet (CLI)](guides/wallet/cli.md)

## Providing Metadata on Assets

This repository hosts public data for the Warthog community. Everyone is welcome to contribute.

Docs available here:
- [Public Data Overview](guides/public-data/index.md)
- [Adding a Node](guides/public-data/nodes.md)
- [Adding an Address Tag](guides/public-data/addresses.md)
- [Submitting Hashrates](guides/public-data/hashrates.md)
- [Registering an Asset](guides/public-data/assets.md)

## Mining
Mining Warthog's Janushash algorithm requires both, a good CPU and a GPU.

Docs available here :
- [Mining quick start guide](guides/mining/quickstart.md)
- [Mining quick start guide FRENCH](guides/mining/quickstart/quickstart_fr.md)
- [Installing opencl](guides/mining/installing-opencl.md)