Enhance README with detailed installation instructions, usage example…

[Dbarve]

This pull request aims to enhance the README.md file for the EDB project, providing clearer and more comprehensive information to users. The updates include detailed installation instructions, prerequisites, usage examples, and contribution guidelines to improve the overall user experience and facilitate community involvement.

Changes Made:

1. Project Description: Added a brief description highlighting EDB as the next-generation debugger for Erlang, emphasizing its advanced debugging capabilities and improved developer productivity.
2. Prerequisites: Detailed the steps required to build and install the modified version of Erlang/OTP, including platform-specific notes for Mac users. Included instructions for verifying the Erlang installation and setting up the necessary environment variables.
3. Download: Provided instructions for downloading pre-built versions of EDB from the Releases page or specific commits via the Commits History page.
4. Usage: Added a basic usage example for starting the DAP adapter for EDB, which is typically used with IDEs like VS Code or Emacs.
5. Contributing: Included a link to the Contribution Guidelines to encourage community contributions and outline how to get involved.

Benefits:

1. Improved Clarity: The updated README provides clear and concise instructions, making it easier for users to get started with EDB.
2. Enhanced Usability: Detailed installation and usage instructions help users set up and use EDB effectively.
3. Community Engagement: Clear contribution guidelines encourage community involvement and ensure consistent code quality.

Testing:

The installation and usage instructions have been tested to ensure accuracy.

The links to external resources, such as the Contribution Guidelines and LICENSE.md, have been verified.

Please review the changes and provide feedback. Thank you!

[facebook-github-bot]

Hi @Dbarve!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[robertoaloi]

Hi @Dbarve and thanks for your contribution. The information you are adding is already available as part of the existing user manual. I think it is a good idea to expand a bit the README and point to the respective sections, but we should not duplicate the content, or the two copies will easily get out of sync.

[robertoaloi]

@Dbarve Closing the PR for the time being.