coral/Countroll
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #4 from thetrouper/main

Browse Source 
Sync Readme
This commit is contained in:
TheTrouper
2023-11-04 19:03:21 -05:00
committed by GitHub
parent aca66990b0 45afa7182d
commit 65eaa9a100
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -19,10 +19,22 @@ Countroll is currently only compatible with [Numselli's counting bot](https://co
## Usage ## Usage
1. Compile the Java program from the source, or download a Precompiled Jar 1. Compile the Java program from the source, or download a Precompiled Jar
2. Execute it through the command-line `java -jar Countroll-<version>.jar` 2. Execute it through the command-line `java -jar Countroll-<version>.jar [args]`
3. Enter a target integer. (Whole number ie: 1, 16, 4096) 3. Enter a target integer. (Whole number ie: 1, 16, 4096)
4. Copy the outputed expression and use it wherever you'd like! 4. Copy the outputed expression and use it wherever you'd like!
## Arguments
There are multiple command line arguments you can use for ease of use
| Argument | Alias(es) | Description |
|-----------|-----------|---------------------------------------------------|
| --copy | -c | Automatically copies the output to your clipboard |
| --verbose | -v | Enables verbose output for debugging |
| --color | -rgb | Enables colored output for debug/it looks cool |
| --deep | -d | Will run the Complexers on the Increaser values |
| --help | --h, -h | Shows a message like this table |
# Compiling # Compiling
Make sure you have Java 17 or higher installed on your system! Make sure you have Java 17 or higher installed on your system!
1. Clone the repo `$ git clone https://github.com/thetrouper/Countroll/` 1. Clone the repo `$ git clone https://github.com/thetrouper/Countroll/`