Improve documentation and build process #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update `README.md` and add `CONTRIBUTING.md` to improve project documentation. * **README.md** - Add a `Contributing` section with a link to the new `CONTRIBUTING.md` file. - Ensure the documentation is up-to-date with the latest changes in the codebase. * **CONTRIBUTING.md** - Provide guidelines on how to contribute to the project. - Include information on the code of conduct. - Add instructions on how to set up the development environment. - Explain the process for submitting pull requests. - Include information on how to report issues and request features. * **docs/_compile/source.doxyfile** - Add more detailed documentation for the various components and modules in the repository. - Ensure that the documentation is up-to-date with the latest changes in the codebase. - Add usage examples and detailed explanations of the API. --- For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/NVIDIAGameWorks/Blast?shareId=XXXX-XXXX-XXXX-XXXX).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update
README.mdand addCONTRIBUTING.mdto improve project documentation.README.md
Contributingsection with a link to the newCONTRIBUTING.mdfile.CONTRIBUTING.md
docs/_compile/source.doxyfile
For more details, open the Copilot Workspace session.