Hi Edward, May I suggest some improvements to the installation documents? They are not general in nature but quite specific, just as you requested. At each change I will argue the case for changes which are beyond mere typos.
At http://leoeditor.com/getting-started.html > Installing Leo http://leoeditor.com/installing.html *Installing Leo* Change first sentence to: "This chapter tells how to install and run Leo on Windows, Linux or MacOS." Don't leave out the Mac users :) *Dependencies* Change "PyQt. You may download PyQt4 or PyQt5." to "PyQt4 or PyQt5." Cleaner, with less duplicate links. Update the obsolete Sphinx link to 'http://www.sphinx-doc.org/en/stable/' *Installing Packages* Delete - "Leo requires the Python and PyQt packages. The PyEnchant package is optional. Leo uses a customized version of PythonTidy, there is no need to install PythonTidy." Duplicate of statements in dependencies about Python and PyQt. PyEnchant is already mentioned above. I don't think there is any need to mention PythonTidy. Delete "Download the PyEnchant package from: http://pythonhosted.org/pyenchant/download.html."; Redundant - there are already 2 previous links to PyEnchant. *Contributing to Leo with git* I have a longer argument for change here but it's in accordance with promoting Git :) Improve the guidance for reader at heading level. If you *really want your users to use git*, then don't offer suggestions to another method in the git section. It is quite irrelevant to the 'Contributing to Leo with git' heading. Once you have the reader at the section on git, stay focussed on git alone, and wax lyrical about it if you like. *Specific Heading "Installing Leo with git"* Again, do you really want more Leo users to use git? If yes then move it from the advanced 'Contributing to Leo with git' heading and have a dedicated *"Installing Leo with git"* heading. I suggest locating it well up near the top of the Contents headings. In the current layout the topic of git is is at the very end of a* long installation page*. "Installing Leo with git" should be simple and very focussed. *Here is the proposed heading order:* Downloading Leo Snapshots Installing Leo Dependencies Installing packages Installing Leo itself Installing Leo on Windows Using the single-click installer Installing from sources (Windows) Creating Windows file associations Installing Leo with git Installing Leo on Linux Installing from a debian package Installing from sources (Linux) Installing Leo on MacOs 10.7 (Lion) and later Contributing to Leo with git* * Again, *"Contributing to Leo with git"* Delete "However, you can get a nightly snapshot of Leo’s git repository (without installing git) from http://www.greygreen.org/leo/"; The links to greygreen.org are obsolete, and already covered at http://leoeditor.com/download.html#snapshots. Optional: consider moving 'Contributing to Leo with git' to another place - Advanced? It has nothing to do with installation. It is a relatively advanced topic and should be solely about the requirements if you want to contribute to Leo. Hope all this helps without distracting you from your worthy focus. Regards Lewis -- You received this message because you are subscribed to the Google Groups "leo-editor" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at https://groups.google.com/group/leo-editor. For more options, visit https://groups.google.com/d/optout.
