Skip to content

Commit 3732061

Browse files
authoredNov 8, 2020
Update README.md
1 parent c5174d8 commit 3732061

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed
 

‎README.md

+10-15
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@
77

88
If you want to modify and share easily your Marlin configuration, Marlin Console Configurator is for **YOU**.
99

10-
Tired of finding each constants by hands to modify and switch between files?
11-
1210
This tool will help you to disable, enable and changes values into your Marlin firmware (currently Configuration.h & Configuration_adv.h) with just only a minimalistic wanted config.
1311

1412
- [Marlin Console Configurator](#marlin-console-configurator)
@@ -22,17 +20,16 @@ This tool will help you to disable, enable and changes values into your Marlin f
2220
+ [Concrete example: show all changes and save modifications to Marlin firmware files](#concrete-example-show-all-changes-and-save-modifications-to-marlin-firmware-files)
2321
+ [Concrete example: Create a profile from your current config](#concrete-example-create-a-profile-from-your-current-config)
2422
* [Usage](#usage)
23+
* [A problem?](#a-problem)
2524
* [Credits](#credits)
2625

2726
Cool things:
2827
- No need to fork Marlin repository, and have a git pull-rebase-conflicts-f**k. Just download/clone last Marlin sources and run marlin-console-configuration onto wanted profile.
29-
- Hey bro', I have 5 printers, and it is a loot difficult to maintain Marlin up-to-date for all printers...
30-
- No problem, just use same Marlin repository, while you just have to apply 5 different profiles
31-
- Naaaaahh, really ?
32-
- Yes, it is as simple as it is
33-
- You can share your profile with friends, or on a tutorial.
28+
- No more Ctrl+F to find the constant to change
29+
- Same Marlin version/code, when you can apply the wanted profile of targeted printer
30+
- Share profile with friends, or on a tutorial.
3431
- It is not doing anything else than modifying C/C++ header files (`.h`), so it don't care about Marlin version !
35-
- It will not add/remove/reorder constants, but just modifying only what is needed :)
32+
- It will not add/remove/reorder constants, but just modifying only what you wanted into your profile :)
3633

3734
Bad things:
3835
- This tool is so quick that you have no time to take a coffee while it is running :D
@@ -110,7 +107,7 @@ marlin-console-configurator.bat help
110107
marlin-console-configurator apply ./Marlin -p ./ender-3-base.yml ./ender-3-abl.yml
111108
```
112109
You will see something like this:
113-
![apply-without-saving](./docs/images/apply-without-saving.png)
110+
![apply-without-saving](docs/images/apply-without-saving.png)
114111

115112

116113
### Concrete example: show all changes and save modifications to Marlin firmware files
@@ -122,7 +119,7 @@ marlin-console-configurator apply ./Marlin -p ./ender-3-abl.yml --save
122119
### Concrete example: Create a profile from your current config
123120
```shell script
124121
marlin-console-configurator generate-profile ./Marlin -o ./my-new-profile.yml
125-
```
122+
```
126123

127124
## Usage
128125

@@ -142,7 +139,7 @@ Usage: marlin-console-configurator [command] [command options]
142139
when present, the changes will be saved without prompting the user
143140
Default: false
144141
145-
diff Display differences between marlin configuration files
142+
diff Display differences between two marlin configuration files/folders
146143
Usage: diff [options]
147144
Options:
148145
* --left
@@ -161,10 +158,8 @@ Usage: marlin-console-configurator [command] [command options]
161158
Usage: help
162159
```
163160

164-
## Tasks
165-
166-
### Todo
167-
- Can create a backup.yaml when applying
161+
## A problem?
162+
Please go to [Issues](/issues), find a similar issue, or create a new one with your problem.
168163

169164
## Credits
170165
Made with :heart: by Chuckame

0 commit comments

Comments
 (0)
Please sign in to comment.