Skip to content

Commit

Permalink
Chore: Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Justaus3r authored Jul 31, 2021
1 parent a48bd6e commit 777da9e
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@

# Ccube

![language](https://badgen.net/badge/Language/Python/cyan)
![semver](https://badgen.net/badge/Semantic-Version/0.1.0/purple)

A small and very simple python script to check for Collatz conjecture.can automatically save the current number on iteration upon abortion.also has the ability to resume the check from a given number.
A small and very simple python script to check for Collatz conjecture.it can automatically save the current number on iteration upon abortion.also has the ability to resume the check from a given number.

### So what the hell is collatz conjecture:
Copllatz conjecture is a mathematical conjecture that concerns to following sequence:
- Take any positive number.if its an odd number then multiply it with 3 and add 1 to add.i.e 3x+1 where x is that number.if its an even number then divide it by 2 .then take the answer and repeat these steps,no matter what, the sequence will always reduce to 1.

The problem is that we don't know that if this conjecture is true for every positive integer.

Collatz conjecture is one of the [unsolved](https://en.wikipedia.org/wiki/List_of_unsolved_problems_in_mathematics) mathematical problem.

Collatz conjecture is one of the [unsolved](https://en.wikipedia.org/wiki/List_of_unsolved_problems_in_mathematics) mathematical problem.for more information about collatz conjecture check out [wikipedia](https://en.wikipedia.org/wiki/Collatz_conjecture).

### And what can ccube do for me:
Well it can do some good things for you.it can
Expand All @@ -27,7 +25,7 @@ Well it can do some good things for you.it can
On all operating systems.executables are only provided for windows tho.

### Usage:
[Download]() the zip file and extract it and simply run the executable.to stop it i would advise you to use ```ctrl + c``` on windows and ```ctrl + z``` on linux,the benefit for stopping like this is that your current number count will get save in a file(called save_curr_no.txt) and you can resume it later.for resuming there are two ways,either:
[Download](https://github.com/Justaus3r/Ccube/releases/download/v0.1.0/ccube.zip) the zip file and extract it and simply run the executable.to stop it i would advise you to use ```ctrl + c``` on windows and ```ctrl + z``` on linux,the benefit for stopping like this is that your current number count will get save in a file(called save_curr_no.txt) and you can resume it later.for resuming there are two ways,either:
- Open cmd in as directory as the executable and type ```ccube <the number you want to resume with>```(without <>).
- There is a file name ```_resume_iter.txt```.open it and paste the number that you want to resume with.now run the executable and it will resume from that count.

Expand All @@ -38,7 +36,7 @@ For running from source.simply
- Run using ```python ccube.py```

### Download:
You can download the zip named ```ccube.zip``` from [Release]() page.
You can download the zip named ```ccube.zip``` from [Release](https://github.com/Justaus3r/Ccube/releases/tag/v0.1.0) page.

### Future Update:
Depends if it is useful then i might update it.but i don't plan to do that now.
Expand Down

0 comments on commit 777da9e

Please sign in to comment.