Selaa lähdekoodia

Reference to the documentation and explain how to generate pdf/html

Samuel Thibault 14 vuotta sitten
vanhempi
commit
8a138f3417
1 muutettua tiedostoa jossa 22 lisäystä ja 9 poistoa
  1. 22 9
      README

+ 22 - 9
README

@@ -104,22 +104,35 @@ StarPU to hang or exhibit incorrect behaviour.
 For details on the Windows build process, see the README.dev file in the
 For details on the Windows build process, see the README.dev file in the
 subversion tree.
 subversion tree.
 
 
-++===========++
-|| V. Trying ||
-++===========++
+++==================++
+|| V. Documentation ||
+++==================++
+
+TexInfo documentation is available in doc/ . If LaTeX is available on the
+machine, a pdf can be generated by running
+
+  $ make -C doc pdf
+
+If makeinfo is available on the machine, html pages can be generated by running
+
+  $ make -C doc html
+
+++============++
+|| VI. Trying ||
+++============++
 
 
 Some examples ready to run are installed into $prefix/lib/starpu/{examples,mpi}
 Some examples ready to run are installed into $prefix/lib/starpu/{examples,mpi}
 
 
-++=============++
-|| VI. Upgrade ||
-++=============++
+++==============++
+|| VII. Upgrade ||
+++==============++
 
 
 To upgrade your source code from older version (there were quite a few
 To upgrade your source code from older version (there were quite a few
 renamings), use the tools/rename.sh script
 renamings), use the tools/rename.sh script
 
 
-++==============++
-|| VII. Contact ||
-++==============++
+++===============++
+|| VIII. Contact ||
+++===============++
 
 
 For any questions regarding StarPU, please contact the starpu-devel
 For any questions regarding StarPU, please contact the starpu-devel
 mailing-list at starpu-devel@lists.gforge.inria.fr .
 mailing-list at starpu-devel@lists.gforge.inria.fr .