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.

Sign up for GitHub

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

Jump to bottom

Better end-user documentation #39

Closed
cochrane opened this issue Feb 6, 2013 · 1 comment
Closed

Better end-user documentation #39

cochrane opened this issue Feb 6, 2013 · 1 comment
Labels
bug enhancement
Milestone
Version 0.2.0

Comments

@cochrane
Copy link
Owner

cochrane commented Feb 6, 2013

Currently, it's obvious to me how to use the app, and rather difficult for anyone else. Especially with #36, having documentation is essential. A readme would be nice, a complete Apple help system might be ideal, especially since most users do not look at Github.
@cochrane
Copy link
Owner Author

Overview over the proposed pages:

  • Where to get models (point to TRF, DA, mention that other sources exist)
  • Navigate in 3D
  • Tutorial: Pose a model
  • Change mesh settings (and save meshes, aka Allow saving of modified items #41 )
  • Render to image
  • Texture packs
  • Loading and saving of poses

More pages as users get stuck. The final three will be very short. All of this presumably in the Wiki here first, if I can make it accessible through the Apple Help system. Otherwise I'll have to devise a system that allows me to store these things in Markdown, so I don't have to build HTML files by hand.

All these pages have to be in English and German. Screenshots would be nice, where applicable.

cochrane added a commit that referenced this issue Feb 27, 2013
@cochrane
Initial setup for help book. This is the foundation for issue #39.
9181420
cochrane added a commit that referenced this issue Feb 28, 2013
@cochrane
Created full text for user documentation in German.
a79c528 
Working on #39. The text is done in German. It needs images, and it
needs to be translated into english. Also, indexing doesn't seem to
work perfectly yet, so that needs some looking after. As a result, a
number of links does not work at the moment.
cochrane added a commit that referenced this issue Feb 28, 2013
@cochrane
Updated german help files so the index can be created properly.
cef9b1a 
So that's how Apple help works. Fascinating. Now I just need the
screenshots and the english version, then #39 can be closed.
cochrane added a commit that referenced this issue Feb 28, 2013
@cochrane
Open the help menu from different places; add help for lights
4882860 
More in order to satisfy #39. Now only needs screenshots and english
text.
cochrane added a commit that referenced this issue Feb 28, 2013
@cochrane
Added images for german help.
794a089 
This means issue #39 is now almost done; now english (with english
screenshots) is necessary.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug enhancement
Projects
None yet
Milestone
Version 0.2.0
Development

No branches or pull requests
1 participant
@cochrane