Skip to content

Commit

Permalink
Added README
Browse files Browse the repository at this point in the history
  • Loading branch information
toydotgame committed Aug 20, 2021
1 parent d5fa77e commit 440cea7
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Collatz Sequence Generator
This is a simple program that I made as a proof of concept and simple introduction to the Collatz Conjecture (also known as _the 3x+1 Problem_).

## Use
### Requirements
* Java (>= 1.8.0\_292)

### Running
Download a JAR from the [_Releases_](https://github.com/toydotgame/collatz-conjecture-sequence-generator/releases) section, open a terminal in your download directory, and run this:
```sh
java -jar Collatz.jar
```

### Configuration
There are three options available currently:
Option Name | Options | Description
----------- | ------- | -----------
Show calculation steps? | `y` or `n` | Show each individual number in the sequence of numbers calculated. If `n` is chosen, stats will be shown at the end about sequence length, and numbers of odd and even numbers.
Print equations? | `y` or `n` | If a number is odd, `3 * x + 1 = y` is printed; and if even `x / 2 = y` is printed. The equations printed may differ from how the numbers themselves are internally calculated, but both the output and the internals of this program follow the rules of the Collatz Conjecture exactly.
Say if a number is odd or even? | `y` or `n` | Adds a prefix to the start of each line saying the odd/evenness of the previous number, and the new number that has been calculated \[according to the rules\].

0 comments on commit 440cea7

Please sign in to comment.