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

Add example for adding custom character #101

Merged
merged 1 commit into from
May 22, 2020
Merged

Add example for adding custom character #101

merged 1 commit into from
May 22, 2020

Conversation

LeCyberDucky
Copy link
Contributor

Description

I have added a small example to the readme showing how to add custom characters.

Motivation and Context

So far, the syntax for adding characters isn't clear from the readme. This adds an example to make it easy for users add their own characters.

How Has This Been Tested?

I have only changed the readme. I have tested that the snippet actually does what it is supposed to and I have checked that the updated readme looks like it should.

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • [x ] New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • [x ] I have updated the documentation accordingly.
  • [x ] I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

I'm not sure if all of the above applies, since I didn't actually change code. I just added a snippet to the readme. I hope this can help somebody, since I had a bit of trouble working this out myself :)

@nhoizey
Copy link
Owner

nhoizey commented May 22, 2020

Thanks a lot for this valuable addition! 👍

@nhoizey nhoizey merged commit b8570b2 into nhoizey:master May 22, 2020
@nhoizey
Copy link
Owner

nhoizey commented May 22, 2020

Fixes #100

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants