Provide some useful information in README file, rather than punting.
---
README | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
Provide some useful information in README file, rather than punting.
---
README | 24 +++++++++++++++++++++++-
1 file changed, 23 insertions(+), 1 deletion(-)
======
only in patch2:
unchanged:
--- README (revision 2413)
+++ README (working copy)
@@ -1,3 +1,25 @@
-openocd.texi is the authoritative source of OpenOCD documentation
+Welcome to OpenOCD!
+The INSTALL file contains tips to configure and compile the source.
+The OpenOCD User's Guide can be produced in two different format
+
+ # If PDFVIEWER is set, this creates and views the PDF User Guide.
+ make pdf && ${PDFVIEWER} doc/openocd.pdf
+
+ # If HTMLVIEWER is set, this creates and views the HTML User Guide.
+ make html && ${HTMLVIEWER} doc/openocd.html/index.html
+
+The OpenOCD Developer Manual contains information about the internal
+architecture and other details about the code:
+
+ make doxygen
+
+ # If HTMLVIEWER is set, this views the HTML Doxygen output.
+ ${HTMLVIEWER} doxyegen/index.html
+
+For more information, refer to these documents or contact the developers
+by subscribing to the OpenOCD developer mailing list:
+
+ [email protected]
+
_______________________________________________
Openocd-development mailing list
[email protected]
https://lists.berlios.de/mailman/listinfo/openocd-development
