bitcoin-dev-project / warnet

Monitor and analyze the emergent behaviors of Bitcoin networks
https://warnet.dev
MIT License
93 stars 35 forks source link

update install docs #668

Closed willcl-ark closed 1 week ago

willcl-ark commented 1 week ago

Closes: #666

May not directly address:

Conclusion: the simplest route should probably be emphasized in the doc. Install Docker Desktop, create a Python venv, pip install warnet, warnet setup, done. Installing the deps globally can still be discussed but it should probably not be the default route when following the docs?

But I think the re-ordering should help significantly.

If we really want to address this comment, perhaps we should re-introduce warnet quickstart or something?

pinheadmz commented 1 week ago

LGTM - but considering the experience weve had thus far i think the very top of the page should look something like this:


TLDR

pip install warnet
warnet setup
willcl-ark commented 1 week ago

LGTM - but considering the experience weve had thus far i think the very top of the page should look something like this:


TLDR


pip install warnet

warnet setup

I can add this section at the top if you're serious? I do agree it would be pretty nice myself...

(But I'd add venv create/activate too)

willcl-ark commented 1 week ago

Hmmm as I sketch it out, I'm not sure a TLDR section is necessary with the new structure. And once we include a python venv, and a k8s cluster, we just end up repeating what is already in this change?

pinheadmz commented 1 week ago

OK! ty <3