X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=README;h=a683476c460e911911bfb17065853f4095278aa7;hp=741432302e613de2b2ab589c41f2321fbdefcc8b;hb=2986320cde399b0b0ee006a4fecbdec83bebc248;hpb=03c9e48f88fa8b681b77c6c35d6da0a0e838a7e8 diff --git a/README b/README index 741432302e..a683476c46 100644 --- a/README +++ b/README @@ -64,8 +64,8 @@ you can build the in-tree documentation. Installing OpenOCD ================== -On Linux, you may have permissions problems to address. The best -way to do this is to use the contrib/udev.rules file. It probably +On Linux, you may have permissions problems to address. The best way +to do this is to use the contrib/openocd.udev rules file. It probably belongs somewhere in /etc/udev/rules.d, but consult your operating system documentation to be sure. In particular, make sure that it matches the syntax used by your operating system's version of udev. @@ -258,6 +258,9 @@ options may be available there: --enable-httpd Enable builtin httpd server - useful for standalone OpenOCD implementations + --disable-doxygen-html Disable building Doxygen manual as HTML. + --enable-doxygen-pdf Enable building Doxygen manual as PDF. + Miscellaneous Configure Options ------------------------------- @@ -314,7 +317,7 @@ The libftdi source code can be download from the following website: For both Linux and Windows, both libusb and libftdi must be built and installed. To use the newer FT2232H chips, supporting RTCK and USB high -speed (480 Mbps), you need libftdi version 0.16 or newer. Many Linux +speed (480 Mbps), use libftdi version 0.17 or newer. Many Linux distributions provide suitable packages for these libraries. For Windows, libftdi is supported with versions 0.14 and later. @@ -335,7 +338,7 @@ all operating systems used with OpenOCD. You may, however, build such copies for personal use. The FTDICHIP drivers come as either a (win32) ZIP file, or a (Linux) -TAR.GZ file. You must unpack them ``some where'' convient. As of this +TAR.GZ file. You must unpack them ``some where'' convenient. As of this writing FTDICHIP does not supply means to install these files "in an appropriate place." @@ -385,6 +388,11 @@ choice from the main repository: git://openocd.git.sourceforge.net/gitroot/openocd/openocd +You may prefer to use a mirror: + + http://repo.or.cz/r/openocd.git + git://repo.or.cz/openocd.git + Using the GIT command line client, you might use the following command to set up a local copy of the current repository (make sure there is no directory called "openocd" in the current directory): @@ -396,9 +404,10 @@ Then you can update that at your convenience using git pull There is also a gitweb interface, which you can use either to browse -the repository or to downlad arbitrary snapshots using HTTP: +the repository or to download arbitrary snapshots using HTTP: http://openocd.git.sourceforge.net/git/gitweb.cgi?p=openocd/openocd + http://repo.or.cz/w/openocd.git Snapshots are compressed tarballs of the source tree, about 1.3 MBytes each at this writing.