Adding example images, LICENSE and README

Author: lplawlor

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 L. P. Lawlor
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,72 @@
+<p align="center">
+  <img src="./assets/sign.png" alt="Bring Your Own Blocks" width=600 style="image-rendering:pixelated"/>
+</p>
+
+<p align="center">
+    <strong>
+        A resource pack generator for Minecraft's menu backgrounds.
+    </strong>
+</p>
+
+Replace your old dirt-y menu backgrounds with whatever texture you want!
+
+*Bring Your Own Blocks* generates a resource pack from any† square texture, with support for multiple pack formats.
+
+† Textures with side lengths of 1, 2, 4, 8, 16 or 32 pixels work best, but go nuts.
+
+## Examples
+
+### Weathered Copper
+<img src="./assets/weathered_copper.png" alt="Create New World Menu using Weathered Copper Background">
+
+### Soul Sand
+<img src="./assets/soul_sand.png" alt="Options Menu using Soul Sand Background">
+
+### Dark Oak Planks
+<img src="./assets/dark_oak_planks.png" alt="Music & Sounds Menu using Dark Oak Planks Background">
+
+### Faithful 32x Dirt
+<img src="./assets/faithful_32_dirt.png" alt="Multiplayer Menu using Faithful 32x Dirt Background">
+
+### Requirements
+*Bring Your Own Blocks* requires [Python](https://www.python.org/) (version 3.11 or greater) with the [Click](https://click.palletsprojects.com/) and [Pillow](https://python-pillow.org/) packages installed.
+
+These package requirements can be installed from `requirements.txt` with `pip install -r requirements.txt` or from `Pipfile` with `pipenv install`.
+
+The code linter and formatter [Ruff](https://docs.astral.sh/ruff/) is also included as a development dependency in `Pipfile`, but is not needed.
+
+If you're not sure how to set up your Python environment, I recommend starting with [venv](https://docs.python.org/3/library/venv.html), the standard virtual environment library. Once your virtual environment is activated, run `pip install -r requirements.txt` to install the dependencies.
+
+## Usage
+```sh
+> python byob.py --help
+Usage: byob.py [OPTIONS]
+
+  Generate a resource pack from a texture, targeting the given range of
+  resource pack formats.
+
+Options:
+  -t, --texture FILE        Texture file  [required]
+  -o, --output DIRECTORY    Output folder  [required]
+  -m, --min-format INTEGER  Minimum resource pack format to support
+  -M, --max-format INTEGER  Maximum resource pack format to support
+  --help                    Show this message and exit.
+```
+
+The input texture must be a square image, ideally with a side length that is a power of 2 and less than or equal to 32.
+This is because all textures are resized to 32x32 using nearest-neighbour interpolation to create the tab sprites.
+
+If you're not sure what pack format you will be using, just don't include the `-m` or `-M` options.
+By default, it will generate a pack that attempts to support all versions.
+
+The output folder can be compressed to a `.zip` or left as-is and placed into the Resource Packs folder.
+
+## Attributions
+Dark Oak Planks, Soul Sand and Weathered Copper textures from [Minecraft](https://www.minecraft.net).
+
+32x Dirt texture from [Faithful 32x](https://www.faithfulpack.net/).
+
+Bitmgothic font by [Nomi](https://www.thenomi.org/).
+
+## License
+*Bring Your Own Blocks* is free and open-source software licensed under the [MIT License](./LICENSE.md).