Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
RandyGaul committed Jun 19, 2024
2 parents 183ce1e + 4e6a0e0 commit ea3d667
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,6 @@ If you're stuck and need help then check out the [Discord chat](https://discord.

Feel free to open up an [issue right here on GitHub](https://github.com/RandyGaul/cute_framework/issues) to ask any questions. If you'd like to make a pull request I highly recommend opening a GitHub issue first to start a discussion on any changes you would like to make.

<p align="center"><img src=https://github.com/RandyGaul/cute_framework/blob/master/assets/CF_Logo_Pixel_2x.png></p>

# Contributing

The main ways to contribute to CF are:
Expand Down Expand Up @@ -133,8 +131,10 @@ And that's it! Regenerate your project and you will be able to build your new sa

Once confirmed working as intended, open a pull request to add in your new sample!

# Editing the Docs
## Editing the Docs

All of CF's docs for the [CF website](https://randygaul.github.io/cute_framework/#/) are located here in GitHub [under the docs folder](https://github.com/RandyGaul/cute_framework/tree/master/docs). Editing any of these docs is a good way to contribute to CF through a pull-request.

Please note that the reference pages for functions/structs are automatically generated by CF's [docs parser + generator](https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp). You can run this executable to regenerate all of the docs files for all of CF. If you wish to edit any of the reference pages be sure to edit the appropriate file in CF's actual source code and regenerate the docs by running the CF sample [docs_parser](https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp). You can then create a pull-request for any of the regenerated docs files.

<p align="center"><img src=https://github.com/RandyGaul/cute_framework/blob/master/assets/CF_Logo_Pixel_2x.png></p>

0 comments on commit ea3d667

Please sign in to comment.