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 a readme for application developers #506

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

drewcrawford
Copy link

Orca has extensive documentation written specifically at application developers, see here.

This is my attempt to start the same kind of document for the same kind of audience. The main questions to address in the document are:

  1. What tools are available and which ones should I actually use?
  2. How do I start and stop them, and which of the many commands will help me quickly check my application?
  3. What are typical problems I will encounter and how do I fix them?

I have filled in this information based on the situations that I was confused about so far.

On the last point it would be good to have an equivalent to the orca 'A Request' section (https://gitlab.gnome.org/GNOME/orca/-/blob/main/README-APPLICATION-DEVELOPERS.md?ref_type=heads&plain=0#a-request) to give application developers a clear call to action of some kind. I am not sure what kind; I have been (ab)using the github discussion feature but it would help for the project as a whole to take a position on what application developers ought to do.

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.

1 participant