Commit graph

6 commits

Author SHA1 Message Date
qiangzhao
179ba1e0d8 docs: fix some typos
There are few word spelling errors in the documentation.

This commit addresses those problems.
2018-06-06 13:29:09 -04:00
Jasper St. Pierre
884818222c Remove the old log viewer tool 2015-01-05 12:43:37 -05:00
Dr. Tilmann Bubeck
23fa0e8eea docs: Add keyboard shortcuts
This commit adds four keyboard shortcuts to the developer
documentation that were found from reading the source:

Esc: Toggle between system console and plymouth boot animation.

Ctrl-V: Toogle verbose mode on and off.

Ctrl-U or Ctrl-W: erase a line
2012-05-10 00:44:30 -04:00
Ray Strode
bb8e3afe19 docs: do a pass over new development.txt
I just did a quick read through and made various changes here and
there.
2012-05-07 23:55:12 -04:00
Ray Strode
19f237b7cc docs: specify where to send contributions 2012-05-07 22:33:15 -04:00
Dr. Tilmann Bubeck
987672f234 docs: Start document for developers
This commit starts to document plymouth to help
new contributors get into the code.

The aim of the document is to provide useful information,
such as the overall architecture, the most
important data structures, and howto recipes for
typical user cases, like debugging.

The document is explicitly not meant to be detailed API documentation.
In the future, that type of documentation may be provided with gtk-doc
style annotations.

The documentation is written in asciidoc
(http://www.methods.co.nz/asciidoc/) and is therefore easily readable as
its ascii text and can also be translated into more rich formats
(like HTML).

For example, to get an HTML version of the document:

yum install asciidoc (or equivalent for your distribution)
cd docs
make development.html
2012-05-07 22:30:55 -04:00