rename/reformat documentation to markdown

diff --git a/CONTRIBUTING b/CONTRIBUTING.md
similarity index 100%
rename from CONTRIBUTING
rename to CONTRIBUTING.md

diff --git a/INSTALL.txt b/INSTALL.md
similarity index 96%
rename from INSTALL.txt
rename to INSTALL.md
index e39c122a341b764b0e44506c206d090dd0f9830d..88cb9fff9f09e93bceafb9ca16f4bb9ad16ffeee 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.md
@@ -258,19 +258,19 @@ ChmodBPF/*        - macOS startup item to set ownership and permissions
 CMakeLists.txt - CMake file
 CONTRIBUTING   - guidelines for contributing
 CREDITS                - people that have helped libpcap along
-INSTALL.txt    - this file
+INSTALL.md     - this file
 LICENSE                - the license under which tcpdump is distributed
 Makefile.in    - compilation rules (input to the configure script)
-README         - description of distribution
-README.aix     - notes on using libpcap on AIX
-README.dag     - notes on using libpcap to capture on Endace DAG devices
-README.hpux    - notes on using libpcap on HP-UX
-README.linux   - notes on using libpcap on Linux
-README.macos   - notes on using libpcap on macOS
-README.septel   - notes on using libpcap to capture on Intel/Septel devices
-README.sita    - notes on using libpcap to capture on SITA devices
-README.tru64   - notes on using libpcap on Digital/Tru64 UNIX
-README.Win32   - notes on using libpcap on Win32 systems (with WinPcap)
+README.md      - description of distribution
+doc/README.aix - notes on using libpcap on AIX
+doc/README.dag - notes on using libpcap to capture on Endace DAG devices
+doc/README.hpux        - notes on using libpcap on HP-UX
+doc/README.linux.md - notes on using libpcap on Linux
+doc/README.macos       - notes on using libpcap on macOS
+doc/README.septel   - notes on using libpcap to capture on Intel/Septel devices
+doc/README.sita        - notes on using libpcap to capture on SITA devices
+doc/README.tru64       - notes on using libpcap on Digital/Tru64 UNIX
+doc/README.Win32       - notes on using libpcap on Win32 systems (with WinPcap)
 VERSION                - version of this release
 acconfig.h     - support for post-2.13 autoconf
 aclocal.m4     - autoconf macros

diff --git a/README b/README.md
similarity index 88%
rename from README
rename to README.md
index 24fdc80d6989c0e21aa497b6824d501a1b4294cf..78cc3c4b41b571831ae5d18df1252768da04b88f 100644 (file)
--- a/README
+++ b/README.md
@@ -2,14 +2,17 @@ To report a security issue please send an e-mail to [email protected].
 
 To report bugs and other problems, contribute patches, request a
 feature, provide generic feedback etc please see the file
-CONTRIBUTING in the libpcap source tree root.
+[CONTRIBUTING](CONTRIBUTING.md) in the libpcap source tree root.
+
+The directory doc/ has README files about specific operating systems and
+options.
 
 LIBPCAP 1.x.y
 Now maintained by "The Tcpdump Group"
 https://www.tcpdump.org
 
 Anonymous Git is available via:
-       git clone git://bpf.tcpdump.org/libpcap
+        https://github.com/the-tcpdump-group/libpcap.git
 
 formerly from  Lawrence Berkeley National Laboratory
                Network Research Group <[email protected]>
@@ -67,9 +70,10 @@ kernel source and/or object patches available in:
 
        https://www.tcpdump.org/other/bpfext42.tar.Z
 
-Linux, in the 2.2 kernel and later kernels, has a "Socket Filter"
-mechanism that accepts BPF filters; see the README.linux file for
-information on configuring that option.
+Linux has a number of BPF based systems, and libpcap does not support
+any of the eBPF mechanisms as yet, although it supports many of the
+memory mapped receive mechanisms.
+See the [README.linux](doc/README.linux.md) file for more information.
 
 Note to Linux distributions and *BSD systems that include libpcap:
 

diff --git a/README.aix b/doc/README.aix
similarity index 100%
rename from README.aix
rename to doc/README.aix

diff --git a/README.dag b/doc/README.dag
similarity index 100%
rename from README.dag
rename to doc/README.dag

diff --git a/README.hpux b/doc/README.hpux
similarity index 100%
rename from README.hpux
rename to doc/README.hpux

diff --git a/README.linux b/doc/README.linux.md
similarity index 100%
rename from README.linux
rename to doc/README.linux.md

diff --git a/README.macos b/doc/README.macos
similarity index 100%
rename from README.macos
rename to doc/README.macos

diff --git a/README.septel b/doc/README.septel
similarity index 100%
rename from README.septel
rename to doc/README.septel

diff --git a/README.sita b/doc/README.sita
similarity index 100%
rename from README.sita
rename to doc/README.sita

diff --git a/README.tru64 b/doc/README.tru64
similarity index 100%
rename from README.tru64
rename to doc/README.tru64