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

Feature request: Update README with clearer build instructions #1870

Open
remingtr opened this issue Aug 3, 2024 · 0 comments · May be fixed by #1873
Open

Feature request: Update README with clearer build instructions #1870

remingtr opened this issue Aug 3, 2024 · 0 comments · May be fixed by #1873
Labels

Comments

@remingtr
Copy link

remingtr commented Aug 3, 2024

Is your feature request related to a problem? Please describe.
As a newbie open source developer, I sometimes struggle with build instructions that require prerequisite knowledge. In the README, the instructions for running CyberChef locally already assume that you

  • Have Docker desktop installed
  • Have Docker desktop running
  • Know how to navigate to the localhost URL to use the application

Describe the solution you'd like
Append more instructions on how to run the project locally, by describing every step with as much context as necessary.

Describe alternatives you've considered
This issue has one simple solution, which would be appending more instructions in the README.

Additional context
To be clear, this is the build instructions that would be revised

image
@remingtr remingtr changed the title Feature request: <Insert title here> Feature request: Update README with clear build instructions Aug 3, 2024
@remingtr remingtr changed the title Feature request: Update README with clear build instructions Feature request: Update README with clearer build instructions Aug 3, 2024
@remingtr remingtr linked a pull request Aug 9, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant