Skip to content
This repository has been archived by the owner on Apr 16, 2024. It is now read-only.

Create help files #3

Open
wants to merge 15 commits into
base: refactor
Choose a base branch
from

Conversation

tomodachi94
Copy link

@tomodachi94 tomodachi94 commented Dec 13, 2022

These can be ignored or used as needed. This is primarily so that unicornpkg can attach some documentation to the program, but it will also benefit everyone as well.

This includes documentation for giim, giim's plugin system, and the bbf, nfp and bimg image formats.

Note: The merge target is the refactor branch, not master.

These can be ignored or used
as needed. This is primarily
so that `unicornpkg` can
attach some documentation to
the program, but it will also
benefit everyone as well.

This includes documentation for `giim`, `giim`'s plugin system,
and the `bbf` and `bimg` image
formats.
@tomodachi94
Copy link
Author

The help file for giim, specifically the controls, are a little lackluster. Maybe we should expand on those?

@MasonGulu
Copy link
Collaborator

Hey thanks for this PR, giim's controls are mostly provided through plugins, the only controls it has by default are ctrl+o, ctrl+s, and crtl+h. Mouse events aren't even handled by base giim, those are handled by the integrated mouseControlPlugin.

With that said, I'm hoping to redo a lot of the plugin system and move away from only keyboard controls. I want to add basic graphical menus like the integrated colorPickerPlugin as an officially supported plugin feature.

@tomodachi94
Copy link
Author

I'm going to add more help files, please don't merge this yet.

@tomodachi94
Copy link
Author

tomodachi94 commented Dec 14, 2022

Plugin documentation checklist (for my use):

  • basicEditing
  • basicKeys
  • basicMouse
  • bbf
  • bimg
  • colorPicker
  • keyIndicator
  • margin
  • rulers

Extra plugins:

  • nfp
  • debug

@tomodachi94
Copy link
Author

@MasonGulu I'm done with this, I think it's ready for review.

The `help` utility does it automagically.
@tomodachi94
Copy link
Author

I'm wondering if I should reformat the documentation into Markdown and then use something like Pandoc to convert it to plain text. In the future, this could also help make the documentation more portable with other formats.

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

Successfully merging this pull request may close these issues.

2 participants