diff mupdf-source/thirdparty/brotli/python/README.md @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mupdf-source/thirdparty/brotli/python/README.md	Mon Sep 15 11:43:07 2025 +0200
@@ -0,0 +1,54 @@
+This directory contains the code for the Python `brotli` module,
+`bro.py` tool, and roundtrip tests.
+
+Only Python 2.7+ is supported.
+
+We provide a `Makefile` to simplify common development commands.
+
+### Installation
+
+If you just want to install the latest release of the Python `brotli`
+module, we recommend installing from [PyPI][]:
+
+    $ pip install brotli
+
+Alternatively, you may install directly from source by running the
+following command from this directory:
+
+    $ make install
+
+### Development
+
+You may run the following commands from this directory:
+
+    $ make          # Build the module in-place
+
+    $ make test     # Test the module
+
+    $ make clean    # Remove all temporary files and build output
+
+If you wish to make the module available while still being
+able to edit the source files, you can use the `setuptools`
+"[development mode][]":
+
+    $ make develop  # Install the module in "development mode"
+
+### Code Style
+
+Brotli's code follows the [Google Python Style Guide][].  To
+automatically format your code, first install [YAPF][]:
+
+    $ pip install yapf
+
+Then, to format all files in the project, you can run:
+
+    $ make fix      # Automatically format code
+
+See the [YAPF usage][] documentation for more information.
+
+
+[PyPI]: https://pypi.org/project/Brotli/
+[development mode]: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode
+[Google Python Style Guide]: https://google.github.io/styleguide/pyguide.html
+[YAPF]: https://github.com/google/yapf
+[YAPF usage]: https://github.com/google/yapf#usage