Editing the document (revise install, and adding an example in usage)

ubukawa commented 1 year ago

Thank you for submitting a pull request!

Description

I have edited the documentation. I revised install chapter, and adding an example in usage chapter. Dear @JinIgarashi , I only edited the source, so please build html by using sphinx if this PR is okay for you.

Type of Pull Request

[ ] Adding a feature
[ ] Fixing a bug
[x] Maintaining documents
[ ] Others ()

Verify the followings

[ n/a] Code is up-to-date with the main branch
[ n/a] No build errors after npm run build
[ n/a] No lint errors after npm run lint
[ n/a] No errors on using charites help globally
[ n/a] Make sure all the existing features working well
[ n/a] Have you added at least one unit test if you are going to add new feature?
[x] Have you updated documentation?

Refer to CONTRIBUTING.MD for more details.

ubukawa commented 1 year ago

Dear @JinIgarashi , Thank you very much for your kind confirmation! I see, then I will wait for some one approves this PR. I did not know html is automatically built. Thank you for this.

I would be happy to add Japanese translation for this. If possible, please teach me how I can edit it in the transifex project?

Thank you!!

JinIgarashi commented 1 year ago

@ubukawa FYI https://www.transifex.com/unvt/charites-docs

JinIgarashi commented 1 year ago

@ubukawa Maybe I can transfer my admin permission on transifex to you. It is difficult for me to maintain charites documentation without having rights on GitHub project

unvt / charites