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

Improve "HOW TO TEST" Section in README for ease of use. Documentation && enhancement #53

Open
NegruGeorge opened this issue Jul 30, 2024 · 0 comments

Comments

@NegruGeorge
Copy link
Collaborator

Description:
The "HOW TO TEST" section in the README is missing several crucial points, making it difficult for users to follow the testing procedure. The following points need to be addressed:

Prerequisites: List all necessary tools and dependencies that need to be installed before running the tests. Include specific links for installation.

Example:

Docker: Installation Guide
Docker Compose: Installation Guide
Go: Installation Guide
PNPM: npm install -g pnpm
Foundry: Installation Guide
Geth v1.13.4: go install github.com/ethereum/go-ethereum/cmd/[email protected]
Recommended versions from version.json:

{
  "abigen": "v1.10.25",
  "foundry": "9e2830d7f0566e0d00b1104eeaedd5032a4e556e",
  "geth": "v1.13.4",
  "nvm": "v20.9.0",
  "slither": "0.10.0",
  "kontrol": "0.1.117"
}

Python Requirements: Ensure Python 3.9 or higher is used to avoid argparse errors.

  1. Troubleshooting: Add common issues and troubleshooting steps.
    Example: Permission issues, Docker not starting, etc.

By adding these details, the "HOW TO TEST" section will be much clearer and more user-friendly.

@NegruGeorge NegruGeorge changed the title Improve "HOW TO TEST" Section in README for ease of usage for new joiners. Documentation && enhancement Improve "HOW TO TEST" Section in README for ease of usage. Documentation && enhancement Jul 30, 2024
@NegruGeorge NegruGeorge changed the title Improve "HOW TO TEST" Section in README for ease of usage. Documentation && enhancement Improve "HOW TO TEST" Section in README for ease of use. Documentation && enhancement Jul 30, 2024
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

1 participant