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

Document the library features! #15

Open
robertshepherdcpp opened this issue Dec 19, 2022 · 0 comments
Open

Document the library features! #15

robertshepherdcpp opened this issue Dec 19, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@robertshepherdcpp
Copy link
Owner

So, there are a lot of features that are not documented in our README.md so I have made this issue. This is great for new commers as the code is simple and all you need to do is, follow the template:

Here is an example implementation of CLASS_NAME:

// temlate if there is one
struct CLASS_NAME
{
auto MEMBER_FUNCTION_NAME(); // no implementation

CLASS_NAME(); // constructor, again don't show the implementation.
}

Here is an example use of this feature:

CLASS_NAME class(); // just a quick example

So, all of that will go in the README.md please! You don't need to do all of it, any help will be appreciated!

@robertshepherdcpp robertshepherdcpp added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Dec 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant