Updated README and requirements.txt

nexxai · Nov 11, 2021 · 494bb3a · 494bb3a
1 parent 3702cd4
commit 494bb3a
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,3 +1,19 @@
 # friendly-numbers
 
-As described on [Numberphile](https://www.youtube.com/watch?v=KZ1BVlURwfI), this script will attempt to find friendly numbers that match 10 (by default).
+As described on [Numberphile](https://www.youtube.com/watch?v=KZ1BVlURwfI), this script will attempt to find friendly numbers for a given integer.
+
+## Installation
+Install the dependencies:
+
+```python
+pip3 install -r requirements.txt
+```
+
+## Usage
+Update the `index_search` and `where_to_start` variables in the `friendly.py` file to appropriate values if you are not using the defaults, and then simply run:
+
+```sh
+python3 friendly.py
+```
+
+Progress will be reported on screen every 10,000 checks and written to a checkpoint file for easy resumption if the script is stopped for whatever reason.
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1 @@
+sympy