From 44d5f8568cec1c6147ae0a1ebd143ad84381c026 Mon Sep 17 00:00:00 2001 From: SIMPLE MARK <57036815+THE-SIMPLE-MARK@users.noreply.github.com> Date: Sun, 10 Sep 2023 10:09:15 +0200 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index d2a07d2..7972568 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # bambu-config-to-ini A CLI for converting Bambu Studio config files to .ini for use in Prusa Slicer and similar software. + +### Note: This is a quick side project I made for a bigger project, so it is not exactly developed for production use. +If anyone would like to use this CLI tool with actual panic messages and an overall better experience then feel free to contribute, otherwise open an issue about what you'd like to be added/changed and I will do my best to implement that. + +Also this is literally my first complex Rust project so please don't hate on the code quality / techniques used :) + +## Usage: +``` +bambu-config-to-ini.exe +``` +| Argument | Expected Data | Description | +|--------------------------|---------------|------------------------------------------------------------------------------------------------------------| +| input_json_file | File Path | The JSON config file to convert. | +| inheritance_files_folder | Folder Path | The folder to use when searching for the file input_json_file or any of its parents may inherit data from. |