From 8544d4f75c5760a17a68e4a5c6803bc6ce3da16f Mon Sep 17 00:00:00 2001 From: Victor Westerlund <35688133+VictorWesterlund@users.noreply.github.com> Date: Mon, 23 Nov 2020 18:21:18 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 1522eed..78afc6d 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # PySheeter -Lightweight Pillow Python-script to create and scale sprite sheets from PNGs in folders or individually +Lightweight Pillow Python package to create and scale sprite sheets from individual PNGs or whole folders ## Get started / Basic usage 1. Download and install [Python 3](https://www.python.org/downloads/) for your architecture -2. Download and install [Pillow](https://pypi.org/project/Pillow/) for Python 3 with `pip3` +2. Install the latest build of PySheeter with [`pip3`](https://pypi.org/project/pysheeter/) ```bash -$ pip3 install Pillow +$ python3 -m pip install pysheeter ``` ### Sprite sheet from folder 1. Import `Sheet` from `pysheeter` ```python -from pysheeter import Sheet +from pysheeter import PySheeter ``` 2. Initialize the class with a path to your PNG-folder ```python -spritesheet = pysheeter.Sheet("example/") +spritesheet = PySheeter.Sheet("example/") ``` 3. Create a sprite sheet with `put()` ```python @@ -41,11 +41,11 @@ spritesheet.put("example_h1632.png",(16,32),False) ### Sprite sheet from individual PNG-images 1. Import `Sheet` from `pysheeter` ```python -from pysheeter import Sheet +from pysheeter import PySheeter ``` 2. Initialize the class without any arguments ```python -spritesheet = pysheeter.Sheet() +spritesheet = PySheeter.Sheet() ``` 3. Add PNG-images with `add()` ```python