← Back to team overview

gnusim8085-devel team mailing list archive

Re: [Question #95918]: I want to help with documentation

 

Question #95918 on gnusim8085 changed:
https://answers.launchpad.net/gnusim8085/+question/95918

The Escapist proposed the following answer:
Hi,

yes, the wikibook on assembly programming seems like a suitable place
for such an effort and it would ensure that everybody could get involved
easily - even people who are not (yet) necessarily users of GNUSim8085
but who may still be familiar with the instruction set/processor.

And regarding a blueprint for a "help" section:

For starters, one could import the existing documentation and add it to
the wikibook as a draft for an upcoming version (licensing permitting?)
specifically dedicated to 8085 programming with GNUSim8085, then we
could come up with screenshots and mini tutorials detailing how to use
the simulator in particular and add all these these to the wikibook.

Similarly, evaluating the plethora of links that were previously posted
to the SF.net trackers, should provide us with plenty of topics to cover
in the manual - in the beginning, these links could just be listed in a
section for additional pointers. The most important topics to be covered
could also be derived from these very links, so that a draft section
could be created with the corresponding headings.

There were also several webpages posted that contained dozens of 8085
source code snippets (i.e. 8 bit adding, division etc), that would be
ideal to be ported/added (along with good commentary) to the GNUSim8085
library of examples, possibly by just crediting the source URLs - for
example, see:

http://www.cs.otago.ac.nz/cosc243/lectures/assy_lang_examples.pdf
http://www.8085projects.info/page/free-programs-for-8085-microprocessor.aspx
http://www.scribd.com/doc/17829049/8085
http://www.scribd.com/doc/18225812/Program-1-Mvi-a-52h-Sta-4000h-Hlt-Program-2
http://www.scribd.com/doc/12860300/BASIC-8085-programs

http://webphysics.davidson.edu/faculty/dmb/py310/8085.pdf
http://www.slideshare.net/saumitra5552001/8085-paper-presentation-presentation

In the beginning, these examples could also be directly added to the
wikibook, so that anybody could help port, test and document/comment
each example for use with GNUSim8085 - once the examples are known to
work properly, they could be added to the standard package as files, so
that they can be easily opened and run.

Doing it this way, would also ensure another RFE from the sourceforge tracker, namely:
http://sourceforge.net/tracker/?func=detail&aid=2606758&group_id=86462&atid=579702

Once there is a formal decision to encourage community involvement,
there could also be a news posted via the sourceforge/launchpad webpages
to inform community members that there is now an effort ongoing to
improve the documentation. Similarly, the simulator itself could show a
corresponding welcome screen (or at least update its help/about dialog).

Ultimately, I personally agree that usability of the simulator would be heavily improved, if the documentation could be somehow directly integrated into the program, as discussed over at sourceforge:
http://sourceforge.net/tracker/?func=detail&aid=1875403&group_id=86462&atid=579702

-- 
You received this question notification because you are a member of
GNUSim8085 developers, which is an answer contact for gnusim8085.