Fixed the "dist" target.

[pciutils.git] / README

diff --git a/README b/README
index d960ba19138c1100686a820e8e8cfac57a92abf8..02e7e9385d765d287fcb6b19859c8937c882e692 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
-This package contains the Linux PCI Utilities, version 1.10.
+This package contains the PCI Utilities, version 2.1.9.
 
-Copyright (c) 1997--1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
+Copyright (c) 1997--2001 Martin Mares <mj@ucw.cz>
 
 All files in this package can be freely distributed and used according
 to the terms of the GNU General Public License, either version 2 or
@@ -8,10 +8,13 @@ to the terms of the GNU General Public License, either version 2 or
 policy as for the Linux kernel itself -- see /usr/src/linux/COPYING
 for details.
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-   The Linux PCI Utilities contain various utilities for dealing with the PCI
-bus in Linux:
+   The PCI Utilities package contains a library for portable access to PCI bus
+configuration space and several utilities based on this library. Current
+version works only on Linux and also has an experimental support for FreeBSD,
+but it can be easily extended to work on other systems as well.
+
+   The utilities include:  (See manual pages for more details)
 
        - lspci: displays detailed information about all PCI busses and devices
          in the system, replacing the original /proc/pci interface.
@@ -19,22 +22,36 @@ bus in Linux:
        - setpci: allows to read from and write to PCI device configuration
          registers. For example, you can adjust the latency timers with it.
 
-   See manual pages for more details.
+   The library (and therefore all the utilities) can access PCI registers
+either via the /proc/bus/pci interface present since Linux 2.1.82 or
+via direct hardware access (to be used with older kernels and also for
+hardware diagnostics). It's also capable of reading and interpreting
+register dumps printed by `lspci -x'. Unfortunately, there is no documentation
+on how to use the library yet, so if you want to play with it, just ask
+me for whatever you want.
 
-   You _NEED_ kernel 2.1.82 or newer which supports /proc/bus/pci.
+   To compile the package, just run "make". To install it, "make install".
 
    If you have any bug reports or suggestions, send them to the author.
 
    If you want, subscribe to linux-pci@atrey.karlin.mff.cuni.cz (send
-"subscribe linux-pci Your Full Name" to listproc@atrey.karlin.mff.cuni.cz).
+"subscribe linux-pci" to majordomo@atrey.karlin.mff.cuni.cz).
 Release notes about new versions will be send to the list and problems with
 the Linux PCI support will be probably discussed there, too.
 
    You also might want to look at the pciutils web page containing release
-notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.html.
+notes and other news: http://atrey.karlin.mff.cuni.cz/~mj/pciutils.html .
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+   If you're missing any PCI ID's, please look at the home page of the Linux
+PCI ID Repository at http://pciids.sourceforge.net/ and download an updated
+pci.ids file first. If the current version doesn't contain your devices,
+please send us an update either using the Web interface of the Repository
+or just mail a unified diff against the latest pci.ids to pci-ids@ucw.cz.
 
-TODO:
+   There also exists a utility called PowerTweak which is able to fine tune
+parameters of many chipsets much better than the Bridge Optimization code
+in Linux kernel (already removed in 2.3.x). See http://powertweak.sf.net/
+for more information.
 
-       - Better displaying of IRQ's generated by both PCI and CardBus bridges.
+                                       Have fun
+                                                       Martin