Skip to content

docs: add comprehensive README for Warnet demo project #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

b-l-u-e
Copy link

@b-l-u-e b-l-u-e commented Jun 26, 2025

Add a beginner-friendly guide that teaches users how to:

  • Set up Warnet using standard installation workflow
  • Deploy Bitcoin networks with warnet new command
  • Run existing scenarios (miner_std, tx_flood, reconnaissance)
  • Monitor and interact with networks via dashboard

This provides a simple entry point for new users to learn Warnet without requiring custom scripts or source installation.

Add a beginner-friendly guide that teaches users how to:
- Set up Warnet using standard installation workflow
- Deploy Bitcoin networks with warnet new command
- Run existing scenarios (miner_std, tx_flood, reconnaissance)
- Monitor and interact with networks via dashboard

This provides a simple entry point for new users to learn Warnet
without requiring custom scripts or source installation.
@pinheadmz pinheadmz self-assigned this Jul 1, 2025
@pinheadmz
Copy link
Contributor

This is great work, thank you -- however I was thinking we could offer more resources like in https://github.com/bitcoin-dev-project/battle-of-galen-erso.

What do you think about making this repo a warnet project with a one-tank network (e.g. 94.0.0-5k-inv) and only one scenario (e.g. my_first_attack_5kinv.py). Link to the main warnet docs as much as you can for install and setup and then instruct the user how to monitor their tiny network, execute the attack, and watch its progress.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants