Improve documentation #284
Comments
|
One more item to add to the
I'd also consider adding |
|
I've added |
|
I think it's also worth installing the Scheme API reference manual HTML files. |
|
Agreed. While I myself like plain info documentation, some users could prefer HTML. |
|
Having four help items in the |
|
The menu should be reviewed, I believe. We have to somehow refactor the old docs from gEDA wiki and merge it with our up-to-date documentation (if any). I think we could move the docs first to our wiki, and then probably to another repository. |
|
@vzh So, should we remove those excessive items now? |
|
[1] https://github.com/lepton-eda/lepton-eda/wiki/Screenshots |

READMEfile content should be moved toa new
INSTALLfile. This file should also include a linkto the
Lepton EDA and Cygwinwiki page.READMEshould be extended to provide more informationabout the
Lepton EDAsuite:geda-gafdevelopersgeda-gafNEWSfileINSTALLfile)in
READMEitself)lepton-edacan easily be extended through the rich (and very well documented)SchemeAPI (GNU Guile)(
share/doc/lepton-eda/):READMENEWSConfiguration settings(included in the reference manual)Attributeswiki pages (should be added to the manual)Configuration(HTML) document should be added;add a new
Help->Configurationmenu item for it.This document should contain:
component-libraryandsource-libraryoptions andwhere to place them. This is the most misunderstood subject. Wiki page
(
wiki/geda-gschem_ug-config.html) is not clear enough on that.with information on how to configure various tools in the
Lepton EDAsuite.the Lepton EDA Reference Manual or a separate (wiki?) document.
It's not suitable anymore to advise users to read
gEDAwiki docs:updated interface, different command names, new features like
configuration system (among others), require us to make new,
Lepton-specific docs.
Tutorial should be as simple as possible (no
gTAGstuff, please).It should contain many pictures, screenshots and links to
other parts of documentation, web sites and communication
channels.
UPDATE: Wiki page with Lepton EDA screenshots has been added.
The text was updated successfully, but these errors were encountered: