Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
babymotte committed Mar 14, 2022
1 parent 3b3cadd commit e658b4d
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# ShanksBot-RS

A rust implementation of the ShanksBot shown by Matt Parker in [this video](https://www.youtube.com/watch?v=DmfxIhmGPP4).

It counts the number of decimals of a reciprocal of a given prime* number before they start repeating.
A rust implementation of the ShanksBot shown by [Matt Parker](https://standupmaths.com/) in [this video](https://www.youtube.com/watch?v=DmfxIhmGPP4).
It counts the number of decimals of a reciprocal of a given prime* number before they start repeating (watch the video for more details).

*it is supposed to be used on prime numbers, but any positive integer will work.

## How to use

If you have cargo installed, simply run ```cargo install shanksbot-rs```
You'll need to have a [rust toolchain installed](https://www.rust-lang.org/tools/install). If you don't need the source code you can simply run ```cargo install shanksbot-rs```. Then you can use it from the command line like ```shanks 60017```.
If you prefer running it straight from source code, clone the repository, ```cd``` into the project directory and run ```cargo run -- 60017```. The result will be printed to ```stdout```.

## What's the practical use of this?
There is none that I know of. It was just a fun little exercise. While watching the video.

0 comments on commit e658b4d

Please sign in to comment.