Skip to content
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

New project should include a README #519

Open
pinheadmz opened this issue Sep 3, 2024 · 4 comments
Open

New project should include a README #519

pinheadmz opened this issue Sep 3, 2024 · 4 comments
Assignees

Comments

@pinheadmz
Copy link
Contributor

The readme should have instructions to pip install Warnet and activate a venv.

This way users can push their project directory to GitHub and it will be self explanatory to anyone they share it with

@willcl-ark
Copy link
Contributor

See quickstart.md for “inspiration”

@josibake
Copy link
Collaborator

josibake commented Sep 4, 2024

ACK , I would envision it also explaining the scenarios/ and networks/ directories and a quick explanation of how configuration works, with pointers back to the warnet documentation for more in depth docs.

@willcl-ark
Copy link
Contributor

ACK , I would envision it also explaining the scenarios/ and networks/ directories and a quick explanation of how configuration works, with pointers back to the warnet documentation for more in depth docs.

Is this not covered in https://github.com/bitcoin-dev-project/warnet/blob/main/docs/config.md ?

@m3dwards
Copy link
Collaborator

This doc includes venv activation: https://github.com/bitcoin-dev-project/warnet/blob/main/docs/install.md

Closing

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

No branches or pull requests

4 participants