Merge pull request #29 from Dog-Face-Development/willtheorangeguy-v0.3.0

Add new install instructions

Author: willtheorangeguy

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [v0.3.0](https://github.com/willtheorangeguy/LEGO-Block-Creator/releases/tag/v0.3.0)
+
+### Added
+
+- Docker container.
+- PyPI package.
+
 ## [v0.2.0](https://github.com/willtheorangeguy/LEGO-Block-Creator/releases/tag/v0.2.0)
 
 ### Added

README.md

@@ -12,9 +12,9 @@
 <!-- Badges -->
 <div align="center">
   <!-- Stability -->
-  <img alt="GitHub Test State" src="https://github.com/Dog-Face-Development/LEGO-Block-Creator/actions/workflows/test.yml/badge.svg">
+  <img alt="Docker Build State" src="https://github.com/Dog-Face-Development/LEGO-Block-Creator/actions/workflows/docker-publish.yml/badge.svg">
   <!-- Stability -->
-  <img alt="GitHub Build State" src="https://github.com/Dog-Face-Development/LEGO-Block-Creator/actions/workflows/build.yml/badge.svg">
+  <img alt="PyPI Build State" src="https://github.com/Dog-Face-Development/LEGO-Block-Creator/actions/workflows/push-to-pypi.yml/badge.svg">
   <!-- Stability -->
   <img alt="Pylint State" src="https://github.com/Dog-Face-Development/LEGO-Block-Creator/actions/workflows/pylint.yml/badge.svg">
   <!-- CodeQL -->
@@ -65,19 +65,46 @@ You can **[download](https://github.com/Dog-Face-Development/LEGO-Block-Creator/
 
 ## How To Use
 
-To clone and run this application, you'll need [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/) installed on your computer. If you would rather not use Git, you can just download the scripts from GitHub above. From your command line:
+To run the application, you can use [Git and the Python Interpreter](https://github.com/Dog-Face-Development/LEGO-Block-Creator/main/README.md#git), which allows you to clone and run the application, [`pip`](https://github.com/Dog-Face-Development/LEGO-Block-Creator/main/README.md#pip) to create a command line application, or [Docker](https://github.com/Dog-Face-DevelopmentLEGO-Block-Creator/main/README.md#docker) to create a container of the application.
+
+### Git
+
+To clone and run this application, you'll need [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/) installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:
 
 ```bash
 # Clone this repository
-$ git clone https://github.com/Dog-Face-Development/LEGO-Block-Creator.git
+$ git clone https://github.com/Dog-Face-Development/LEGO-Block-Creator
 
 # Go into the repository
 $ cd LEGO-Block-Creator
 
-# Run the App
+# Run the CLI
 $ python main.py
 ```
 
+### `pip`
+
+You can install the program from the [Python Package Index](https://pypi.org/project/LEGO-Block-Creator/) through `pip`.
+
+```bash
+# Install via pip
+$ pip install lego-block-creator
+
+# Run the CLI
+$ lego-block-creator
+```
+
+### Docker
+
+You can pull the [Docker](https://www.docker.com/) image from GitHub Packages. From your command line:
+
+```bash
+# Pull image
+$ docker pull ghcr.io/dog-face-development/lego-block-creator:master
+
+# Run container
+$ docker run -i -t ghcr.io/dog-face-development/lego-block-creator:master python send.py
+```
 ## Support
 
 To create your part and set library and manipulate it, just launch the app using the instructions above!

docs/USAGE.md

@@ -1,19 +1,33 @@
 # LEGO Block Creator Usage
 
-To install LEGO Block Creator, you can either use an executable package (Windows), or run the scripts through Python (Windows, macOS, Linux).
+To install LEGO Block Creator, you can use an executable package (Windows), run the scripts through Python (Windows, macOS, Linux), install from the [Python Package Index](https://pypi.org/), or run a [Docker](https://www.docker.com/) container from [GitHub Packages](https://github.com/Dog-Face-Development/LEGO-Block-Creator/pkgs/container/lego-block-creator).
 
 ## Executable Package
 
 1. To run the executable package, download the latest `.zip` file from [GitHub Releases](https://github.com/Dog-Face-Development/LEGO-Block-Creator/releases/latest) page.
 2. Extract the `.zip` file using a program like [7-Zip](https://www.7-zip.org/).
 3. _(Optional) Move the files to `C:\Program Files` and create a shortcut._
-4. Double click on `main.exe`.
+4. Double click on `send.exe`.
 5. Enjoy the program!
 
 ## Python Script
 
 1. To run the Python script, download the latest source code release from [GitHub Releases](https://github.com/Dog-Face-Development/LEGO-Block-Creator/releases/latest) page.
 2. Download and install [Python](https://www.python.org/downloads/).
 3. Extract the source code files using a program like [7-Zip](https://www.7-zip.org/).
-4. Double click on `main.py`, or right-click and open with IDLE and press `F5`.
+4. Double click on `send.py`, or right-click and open with IDLE and press `F5`.
 5. Enjoy the program!
+
+## Python Package Index (`pip`)
+
+1. Download and install [Python](https://www.python.org/downloads/).
+2. Open a terminal and run the command: `pip install lego-block-creator`.
+3. Start the program by running the command: `lego-block-creator`.
+4. Enjoy the program!
+
+## Docker Container
+
+1. Download and install [Docker](https://www.docker.com/products/docker-desktop/).
+2. Open a terminal and pull the container: `docker pull ghcr.io/dog-face-development/lego-block-creator:master`.
+3. Start the container: `docker run -i -t ghcr.io/dog-face-development/lego-block-creator:master python main.py`.
+4. Enjoy the program!