Menu

Tree [fa1275] default tip /
 History

Read Only access


File Date Author Commit
 NCIDdisplayLED 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.
 PWB 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.
 assembly 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.
 .hgtags 2018-07-02 John L. Chmielewski John L. Chmielewski [fa1275] Added tag 0.6 for changeset 016b6f29139a
 CHANGES 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.
 Makefile 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.
 README.docdir 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.
 README.md 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.
 ReleaseNotes.md 2018-07-02 John L. Chmielewski John L. Chmielewski [016b6f] See the CHANGES file.

Read Me

Documentation HELP for NCIDdisplay

The MD files are in markdown text.

The original markdown command line program and documentation can
be obtained from http://daringfireball.net/projects/markdown/

Usage:
    make [html] - builds README.html ReleaseNotes.html and Assembly.html
    make epub   - builds Assembly.epub
Requirements:
    pandoc      - required to bulid HTML files from the MD fiiles
    calibre     - required to build the epub file

    Use any markdown editor you like to view and edit the markdown
    files (*.md).  One good editor is "retext" available from your
    repository or from https://github.com/retext-project/retext

The .md documentation can be converted into other formats using:

    pandoc      - http://johnmacfarlane.net/pandoc/
    calibre     - http://calibre-ebook.com/

Calibre's `ebook-viewer` can display the markdown or epub files.

The Makefile is used to create html files and epub file.

prefix  - default: /usr/local:            $(prefix)/bin and $(prefix)/sbin
prefix2 - default: prefix2 = $(prefix1):  $(prefix2)/etc
prefix3 - default: "":                    $(prefix)/var

prefix2 controls where to look for the config file,
(the default is /usr/local)