From 777da9ec0ee7c6200b63fc38325da49d419ff355 Mon Sep 17 00:00:00 2001 From: Justaus3r <72691864+Justaus3r@users.noreply.github.com> Date: Sat, 31 Jul 2021 23:56:42 +0500 Subject: [PATCH] Chore: Update Readme --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d0a850c..9fc996d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ - # 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: @@ -12,8 +11,7 @@ Copllatz conjecture is a mathematical conjecture that concerns to following sequ 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 @@ -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 ```(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. @@ -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.