Fixed readme.

master
Rostislav Lán 2 years ago
parent fe8eda2310
commit 4990d2ec21

@ -40,14 +40,13 @@ Before cloning repository, you need these to succesfully use the application.
```sh
cd BP_DP-xlanro00
```
v
4. Create and enter the virtual enviroment.
```sh
virtualenv .venv && source .venv/bin/activate
```
5. Install required python modules from requirements.txt.
```sh
pip install -r requirements.txt
```
@ -56,6 +55,11 @@ v
# Filtering images
* You will need to enter the virtual enviroment every time you want to use the application.
```sh
source .venv/bin/activate
```
Once all the requirements are installed, the program is ready to use. There are two ways to enter the filters:
1. manually list filter names and parameters from command line
@ -181,14 +185,14 @@ In base mode the output model will be a curved finger model, with optional param
First optional parameter is papilar line height, second rate of curvature along x axis and the third is the rate of curvature along y axis.
* General form for curved stl generation
```sh
```sh
python3 src/main.py input_file output_file dpi --config config_file preset --stl height_line height_base curvature_x curvature_y
```
```
* Working example curved stl generation
```sh
```sh
python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config config/config.json git_example --stl 2 10 2 2
```
```
# Generating planar finger model
@ -196,14 +200,14 @@ Using `-p` switch makes the generated model planar.
Optional parameters are model base thickness and papilar lines height, they are set after stl file name.
* General form for planar stl generation
```sh
```sh
python3 src/main.py input_file output_file dpi --config config_file preset --stl height_line height_base -p
```
```
* Working example planar stl generation
```sh
```sh
python3 src/main.py res/examples/Palec_P4.tif res/examples/Palec_P4_from_preset.png 600 --config config/config.json git_example --stl 2 10 -p
```
```
# Mapping to existing finger model

Loading…
Cancel
Save