Add README.md

2024-10-19 21:28:30 +00:00 · 2024-10-19 21:28:30 +00:00 · a54835f406
commit a54835f406
1 changed files with 44 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,44 @@
+# void.php
+
+This artistic marvel is designed to generate avant-garde ASCII art images and post them to your Mastodon account. Because the internet clearly doesn't have enough random character sets and pseudo-profound status messages already.
+
+## Features
+
+- **Random ASCII Art Generation**: Converts a completely random set of characters into a visually chaotic masterpiece.
+- **Image Creation**: Turns the ASCII art into an image with the always-necessary inverted colors.
+- **Text Overlay**: Adds stylish text overlays to remind viewers of the insightful nature of the message.
+- **Mastodon Integration**: Uploads your new art to Mastodon to grace your followers with digital enlightenment.
+- **Random Status Generator**: Picks a random status from a list to accompany your masterpiece.
+
+## Installation
+
+1. **Clone the Repository**  
+   Clone this repository to your local machine using:
+   ```sh
+   git clone https://git.cyberwa.re/revengeday/void.git
+   ```
+
+2. **Font Dependency**  
+   Ensure that the `BlockZone.ttf` font file is available in the script's directory, or modify the path in the script to point to the correct location.
+
+3. **Setup API Keys**    
+   Replace the placeholder text for the Mastodon API access token with your valid access token:
+   ```php
+   $accessToken = 'YOUR_ACCESS_TOKEN_HERE';
+   ```
+   Also, set your instance URL:
+   ```php
+   $instance = 'https://your.mastodon.instance';
+   ```
+
+4. **Create a Status File**  
+   If you want customized statuses, create a `post.txt` file in the script's directory, with each line representing a potential status message.
+
+## Usage
+
+- Access your script via a web browser. It should render your randomly generated works of art as an image when you provide the correct key:
+  ```
+  https://yourserver.com/void.php?key=XXXX-XXXX-XXXX
+  ```
+
+- If you provide the correct key and have configured your Mastodon API token, it will automatically post the generated image along with a randomly chosen status to your Mastodon account.