Mercurial > mplayer.hg

annotate DOCS/README @ 35643:f8eb470c25ea

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add doxygen comments.
author ib
date Sat, 12 Jan 2013 00:04:24 +0000
parents 1bff8cc9ca6b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11077
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
1
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
2 #######################################
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
3 ## Reading the MPlayer Documentation ##
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
4 #######################################
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
5
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
6 Thanks for reading MPlayer documentation !!!
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
7
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
8
28167
4c9698666a4c Remove/fix ancient CVS references.
diego
parents: 11204
diff changeset
9 1. For "release" version users (i.e. non-Subversion):
11077
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
10
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
11 a, Enter the HTML/ directory, and there you'll find the documentation,
11098
b16e131edc78 some typos, extended explanation
diego
parents: 11077
diff changeset
12 each language in its own subdirectory.
11077
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
13
29263
0f1b5b68af32 whitespace cosmetics: Remove all trailing whitespace.
diego
parents: 28167
diff changeset
14 b, If you prefer reading the documentation as a single big file it
29965
1bff8cc9ca6b Do not build monolithic documentation in a separate directory.
diego
parents: 29263
diff changeset
15 can be found in the file MPlayer.html, each language in its
11202
1470e4dd1a4a Include HTML-single in README's.
wight
parents: 11098
diff changeset
16 own subdirectory.
1470e4dd1a4a Include HTML-single in README's.
wight
parents: 11098
diff changeset
17
29965
1bff8cc9ca6b Do not build monolithic documentation in a separate directory.
diego
parents: 29263
diff changeset
18 c, If the HTML/ directory does not contain your language,
11202
1470e4dd1a4a Include HTML-single in README's.
wight
parents: 11098
diff changeset
19 try the subdirectories in this very same folder.
11077
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
20
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
21
28167
4c9698666a4c Remove/fix ancient CVS references.
diego
parents: 11204
diff changeset
22 2. For "development" version users (i.e. Subversion or Subversion snapshots):
11077
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
23
11098
b16e131edc78 some typos, extended explanation
diego
parents: 11077
diff changeset
24 a, Enter the xml/ directory, and read the README file there to find
b16e131edc78 some typos, extended explanation
diego
parents: 11077
diff changeset
25 out how to build a HTML version of the XML documentation. It will
29965
1bff8cc9ca6b Do not build monolithic documentation in a separate directory.
diego
parents: 29263
diff changeset
26 be created in the HTML/ directory.
11077
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
27
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
28 b, If the xml/ directory doesn't contain your language, try the
d8925793bf06 generic instructions on DOCS subdirectories
gabucino
parents:
diff changeset
29 subdirectories in this very same folder.