From 4d24d27b99bf5dacbbd73189a7becb6dbe2d9d1d Mon Sep 17 00:00:00 2001 From: Simon Jones Date: Sun, 28 Apr 2024 22:00:51 -0400 Subject: [PATCH] doc: adding information about added algorithms in README --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 56b54ba..fcfac1d 100644 --- a/README.md +++ b/README.md @@ -29,15 +29,23 @@ poetry run bosco --starting-size 100 --number-doubles 5 --file bosco/sorting.py The command uses the following inputs: -- `--starting-size` for the initial list size to start the doubling experiment +- `--starting-size` for the initial list size to start the doubling experiment. - `--number-doubles` for the number of times the input size will be doubled - during the doubling experiment + during the doubling experiment. - `--file` for the path to the file containing the sorting algorithm you want to - run the doubling experiment on + run the doubling experiment on. - `--function-name` for the name of the function containing the sorting - algorithm you want to test + algorithm you want to test. - `--element-type` for the data type to fill the randomly generated containers. +This project supplies an array of Python files with list operations in them: + +* `bosco/list_processing/basics.py`: basic list operations +* `bosco/list_processing/combination.py`: list operations involving combination +* `bosco/list_processing/search.py`: searching algorithms for lists +* `bosco/list_processing/sorting.py`: sorting algorithms for lists +* `bosco/list_processing/other.py`: other uncategorized operations + ## Example of command and output ### Command