diff --git a/README.md b/README.md index 0a96fba053409b285c62617c8be0439e2404c834..2bbf25969a327619bb5244048fb99baa616be621 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,47 @@ # Aruco Frame +## Installation + +Steps: +- Clone or download this project, and place the folder somewhere +- Install python>3.8 ([link](https://www.python.org/downloads/)) +- Add python to your system's path ([guide](https://realpython.com/add-python-to-path/)) +- Open a terminal and navigate to the project's folder +- Install dependencies: + +``` +python -m pip install -r requirements.txt +``` + +- Test: + +``` +python aruco-frame.py -i example/raspi.jpg +``` + ## Usage +### Process an image: + +``` +python aruco-frame.py -i <FILENAME_IN> +``` + +If the output path is not specified with a `-o <FILENAME_OUT>` argument, the result is saved as `<FILENAME_IN>_<DPI>_DPI.png`. + +## User manual + ``` usage: aruco-frame.py [-h] [-i INPUT] [-o OUTPUT] [-d DPI] [-s] [-c CONFIG] [-v] -Usage: python aruco-frame.py [options] +Extracts the image from an image containing an aruco frame options: -h, --help show this help message and exit -i INPUT, --input INPUT Input filename. -o OUTPUT, --output OUTPUT - Output filename (default: <filename_in>_extracted.png). + Output filename (default: <filename_in>_<DPI>_DPI.png). -d DPI, --dpi DPI Manual output DPI (default: auto). -s, --show Show debug image. -c CONFIG, --config CONFIG diff --git a/aruco-frame.py b/aruco-frame.py index 662a7999b085b5a1c4c0aa0b8a8ab8b32eec8314..7213a8ee0e92a1687542708669399195d801cf90 100644 --- a/aruco-frame.py +++ b/aruco-frame.py @@ -13,7 +13,7 @@ import solve_lens def parse_arguments(): usage_text = ( - "Usage: python aruco-frame.py [options]" + "Extracts the image from an image containing an aruco frame" ) parser = argparse.ArgumentParser(description=usage_text) parser.add_argument("-i", "--input", type=str, diff --git a/example/raspi_extracted.png b/example/raspi_297_DPI.png similarity index 100% rename from example/raspi_extracted.png rename to example/raspi_297_DPI.png