Merge branch 'docs-update' into main

KasHir · Dec 26, 2023 · 66b3724 · 66b3724
2 parents 0f5b683 + d81205b
commit 66b3724
Show file tree

Hide file tree

Showing 21 changed files with 51 additions and 16 deletions.
diff --git a/.gitignore b/.gitignore
@@ -158,3 +158,12 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# Example input/output files
+out/*
+!out/sample*
+!out/zunda*
+
+img_line/*
+!img_line/sample*
+!img_line/zunda*
diff --git a/README.md b/README.md
@@ -13,21 +13,40 @@ Designed for professionals and DIY enthusiasts seeking efficient machining and c
 
 ## Installation and Dependencies
 
-To use the flats-raster-vector-converter, follow these steps:
+To use the flats-raster-vector-converter, ensure you have Python installed on your system. This tool has been tested on Python 3.11.6. Follow these steps:
 
 1. Clone the repository:
-
 ```bash
 git clone https://github.com/KasHir/flats-raster-vector-converter
 ```
 
 2. Navigate to the project directory:
-
 ```bash
 cd flats-raster-vector-converter
 ```
 
-Ensure you have Python installed on your system. This tool has been tested on Python 3.11.6.
+3. Install the required third-party libraries. While requirements.txt is not yet available, you can manually install the necessary libraries using pip or conda. Here are the commands to install each library with pip:
+```bash
+pip install opencv-python-headless matplotlib networkx numpy scikit-image svgwrite
+```
+
+If you prefer to use conda, you can use the following commands:
+```bash
+conda install -c conda-forge opencv matplotlib networkx numpy scikit-image svgwrite
+```
+
+Note: The library sknw may need to be updated manually for the best results. If you encounter issues with skeletonized graphs, download the latest version of sknw and include it in the ./external/sknw directory of this repository.
+
+4. Ensure you have the OR-Tools library installed, which may require a separate installation step:
+
+With pip:
+```bash
+pip install ortools
+```
+
+Or, if you're using conda, refer to the OR-Tools documentation for the specific installation command, as it may vary depending on your operating system and conda configuration.
+
+A requirements.txt file will be provided in the future to simplify this process.
 
 
 ## Example Use
@@ -49,6 +68,13 @@ The ideal input is a line-art style raster image, which can be prepared using im
 - requirements.txt will be prepared in the future.
 - [List any other known issues or limitations here]
 
+## Acknowledgments
+
+Special thanks to the creators of the example images used in this project. These images are instrumental for demonstrating the capabilities of the flats-raster-vector-converter:
+
+- img_line/sample.png: [https://elshaddai.jp/freedeta.html]
+- img_line/zunda.png : [https://seiga.nicovideo.jp/seiga/im10788496]
+
 ## Contact
 
 For more information, feedback, or questions, feel free to reach out:

diff --git a/img_line/irasutoya.png b/img_line/irasutoya.png
diff --git a/img_line/sample.png b/img_line/sample.png
diff --git a/img_line/simple.png b/img_line/simple.png
diff --git a/img_line/simple2.png b/img_line/simple2.png
diff --git a/out/irasutoya_combined.svg b/out/irasutoya_combined.svg
diff --git a/out/irasutoya_combined_black.svg b/out/irasutoya_combined_black.svg
diff --git a/out/irasutoya_optimized_path.svg b/out/irasutoya_optimized_path.svg
diff --git a/out/irasutoya_optimized_path_invalid.svg b/out/irasutoya_optimized_path_invalid.svg
diff --git a/out/sample_combined.svg b/out/sample_combined.svg
diff --git a/out/sample_combined_black.svg b/out/sample_combined_black.svg
diff --git a/out/irasutoya_combined_graph.png → out/sample_combined_graph.png b/out/irasutoya_combined_graph.png → out/sample_combined_graph.png
diff --git a/out/sample_optimized_path.svg b/out/sample_optimized_path.svg
diff --git a/out/sample_optimized_path_invalid.svg b/out/sample_optimized_path_invalid.svg
diff --git a/out/sample_raw_graph.png b/out/sample_raw_graph.png
diff --git a/out/zunda_combined.svg b/out/zunda_combined.svg
diff --git a/out/zunda_combined_black.svg b/out/zunda_combined_black.svg
diff --git a/out/zunda_combined_graph.png b/out/zunda_combined_graph.png
diff --git a/out/zunda_optimized_path.svg b/out/zunda_optimized_path.svg
diff --git a/out/zunda_optimized_path_invalid.svg b/out/zunda_optimized_path_invalid.svg