Merge pull request #34 from Dog-Face-Development/willtheorangeguy-new-install-docs

Add new installation instructions

Author: willtheorangeguy

README.md

@@ -12,9 +12,7 @@
 <!-- Badges -->
 <div align="center">
   <!-- Stability -->
-  <img alt="GitHub Test State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/test.yml/badge.svg">
-  <!-- Stability -->
-  <img alt="GitHub Build State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/build.yml/badge.svg">
+  <img alt="PyPI Build State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/push-to-pypi.yml/badge.svg">
   <!-- Stability -->
   <img alt="Pylint State" src="https://github.com/Dog-Face-Development/ProgramVer/actions/workflows/pylint.yml/badge.svg">
   <!-- CodeQL -->
@@ -66,19 +64,35 @@ You can **[download](https://github.com/Dog-Face-Development/ProgramVer/releases
 
 ## 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/ProgramVer/main/README.md#git), which allows you to clone and run the application, or [`pip`](https://github.com/Dog-Face-Development/ProgramVer/main/README.md#pip) to create a command line 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/ProgramVer.git
+$ git clone https://github.com/Dog-Face-Development/ProgramVer
 
 # Go into the repository
 $ cd ProgramVer
 
-# Run ProgramVer
+# Run the CLI
 $ python main.py
 ```
 
+### `pip`
+
+You can install the program from the [Python Package Index](https://pypi.org/project/programver/) through `pip`.
+
+```bash
+# Install via pip
+$ pip install programver
+
+# Run the CLI
+$ programver
+```
+
 However, you may want to add the version window to your program. To do so, follow these steps:
 
 1. Download the latest source code release from [GitHub Releases](https://github.com/Dog-Face-Development/ProgramVer/releases/latest) page.

docs/USAGE.md

@@ -1,11 +1,26 @@
 # ProgramVer Usage
 
-To add ProgramVer to your project, follow the steps below. To customize the program to your needs, see [`CUSTOMIZATION`](CUSTOMIZATION.md).
-
-1. To add the version window to your project, download the latest source code release from [GitHub Releases](https://github.com/Dog-Face-Development/ProgramVer/releases/latest) page.
-2. Extract the source code files using a program like [7-Zip](https://www.7-zip.org/).
-3. Copy the `ProgramVer.py` file to your project's main directory.
-4. Import ProgramVer by adding `from ProgramVer import *` to your Python `import` statements.
-5. Customize the version window by following the instructions in [`CUSTOMIZATION`](CUSTOMIZATION.md).
-6. Call ProgramVer through the `ProgramVer()` function.
-7. Enjoy your new version window!
+To install ProgramVer, you can use an executable package (Windows), run the scripts through Python (Windows, macOS, Linux), or install from the [Python Package Index](https://pypi.org/).
+
+## Executable Package
+
+1. To run the executable package, download the latest `.zip` file from [GitHub Releases](https://github.com/Dog-Face-Development/ProgramVer/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 `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/ProgramVer/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 `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!