From c31833e064967c1318fb16a5325e02bfa8b8ece6 Mon Sep 17 00:00:00 2001
From: Benjamin Mako Hill <mako@atdot.cc>
Date: Thu, 6 Aug 2026 16:23:52 -0700
Subject: [PATCH] convert README to markdown

Replace the auto-converted README.md (which carried pandoc title-ref
spans and a garbled Tests heading from a malformed rst underline) with
a clean conversion of README.rst, and remove the rst version.
pyproject.toml already declares README.md as the package readme.
Content is unchanged; bringing it up to date is left for a separate
change.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
(cherry picked from commit fa8adc30ca33806f22a6bfb6619c185279006847)
---
 README.md  | 21 +++++++++++----------
 README.rst | 41 -----------------------------------------
 2 files changed, 11 insertions(+), 51 deletions(-)
 delete mode 100644 README.rst

diff --git a/README.md b/README.md
index 7d59051..768737c 100644
--- a/README.md
+++ b/README.md
@@ -10,28 +10,29 @@ submodule like:
     git submodule update
 
 Wikimedia dumps are usually in a compressed format such as 7z (most
-common), gz, or bz2. Wikiq uses your computer\'s compression software to
-read these files. Therefore wikiq depends on [7za]{.title-ref},
-[gzcat]{.title-ref}, and [zcat]{.title-ref}.
+common), gz, or bz2. Wikiq uses your computer's compression software to
+read these files. Therefore wikiq depends on `7za`, `gzcat`, and `zcat`.
 
 # Dependencies
 
 These non-Python dependencies must be installed on your system for wikiq
 and its associated tests to work.
 
--   7zip
--   ffmpeg
+- 7zip
+- ffmpeg
 
-A new diff engine based on [\_wikidiff2]{.title-ref} can be used for
-word-persistence. Wikiq can also output the diffs between each page
-revision. This requires installing Wikidiff 2 on your system. On Debian
-or Ubuntu Linux this can be done via.
+A new diff engine based on [wikidiff2](https://www.mediawiki.org/wiki/Wikidiff2)
+can be used for word-persistence. Wikiq can also output the diffs
+between each page revision. This requires installing Wikidiff 2 on your
+system. On Debian or Ubuntu Linux this can be done via.
 
 `apt-get install php-wikidiff2`
 
 You may have to also run. `sudo phpenmod wikidiff2`.
 
-Tests \-\-\--To run tests:
+# Tests
+
+To run tests:
 
     python -m unittest test.Wikiq_Unit_Test
 
diff --git a/README.rst b/README.rst
deleted file mode 100644
index dced9ef..0000000
--- a/README.rst
+++ /dev/null
@@ -1,41 +0,0 @@
-When you install this from git, you will need to first clone the repository::
-
-  git clone git://projects.mako.cc/mediawiki_dump_tools
-
-From within the repository working directory, initiatlize and set up the
-submodule like::
-
-  git submodule init
-  git submodule update
-
-
-Wikimedia dumps are usually in a compressed format such as 7z (most common), gz, or bz2. Wikiq uses your computer's compression software to read these files. Therefore wikiq depends on
-`7za`, `gzcat`, and `zcat`. 
-
-Dependencies
-----------------
-These non-Python dependencies must be installed on your system for wikiq and its
-associated tests to work.
-
-- 7zip
-- ffmpeg
-
-A new diff engine based on `_wikidiff2` can be used for word-persistence. Wikiq can also output the diffs between each page revision. This requires installing Wikidiff 2 on your system. On Debian or Ubuntu Linux this can be done via.
-
-``apt-get install php-wikidiff2``
-
-You may have to also run.
-``sudo phpenmod wikidiff2``.
-
-Tests
-----
-To run tests::
-
-   python -m unittest test.Wikiq_Unit_Test
-
-TODO:
-_______________
-1. [] Output metadata about the run. What parameters were used? What versions of deltas?
-2. [] Url encoding by default
-
-.. _wikidiff2: https://www.mediawiki.org/wiki/Wikidiff2