diff --git a/README.md b/README.md index 06acbf589..c547fc0a1 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,40 @@ User specific configuration is possible using the cmder specific shell config fi Note: Bash and Mintty sessions will also source the '$HOME/.bashrc' file it it exists after it sources '$CMDER_ROOT/config/user-profile.sh'. +### Cmder Portable 'Custom' ConEmu Configuration + +*NOTE: Computer custom ConEmu config, see below, will be used if both a matching computer and a user custom xml file exist in the `%CMDER_ROOT%\config` folder* + +By default `cmder.exe` will backup `%CMDER_ROOT%\vendor\ConEmu-Maximus5\ConEmu.xml` if it exists to `%CMDER_ROOT%\config\user-ConEmu.xml` at startup. + +This allows you to: + +* Backup your `%CMDER_ROOT%\config` folder and drop it into a FRESH Cmder install and have ALL your settings! +* Make changes using the ConEmu GUI and have portable custom sessions, hotkeys, and other settings for ConEmu that can persist across new Cmder installs or upgrades. + +Example: If `%CMDER_ROOT%\config\user-ConEmu.xml` exist you can delete the `%CMDER_ROOT%\vendor` folder and copy the contents of a new Cmder binary distribution to `%CMDER_ROOT%`. Launching `cmder.exe` will copy your custom `user-ConEmu.xml` at startup into the new ConEmu folder and use it to launch ConEmu instead of the default Cmder `ConEmu.xml` file.. + +### Cmder Portable 'Computer Custom' ConEmu Configuration + +*NOTE: Computer custom ConEmu config will be used if both a matching computer and a user custom xml file exist in the `%CMDER_ROOT%\config` folder* + +In addition to the benefits of 'Custom' ConEmu config 'Computer Custom' config allows you to: +* Have different sessions, hotkeys, and other settings for ConEmu on different computers using a single Cmder binary distribution. + +For a NEW Cmder install: + +* Rename `%CMDER_ROOT%\config\ConEmu.xml` to `%CMDER_ROOT%\config\ConEmu-%COMPUTERNAME%.xml` +* Set whatever custom settings you like using the ConEmu GUI +* Close and restart `Cmder.exe` and `%CMDER_ROOT%\vendor\ConEmu-Maximus5\ConEmu.xml` will be backed up to `%CMDER_ROOT%\config\ConEmu-%COMPUTERNAME%.xml` at startup. + +For a EXISTING Cmder install: + +* Manually backup your customized `%CMDER_ROOT%\vendor\ConEmu-Maximus5\ConEmu.xml` to `%CMDER_ROOT%\config\ConEmu-%COMPUTERNAME%.xml`. +* Set whatever custom settings you like using the ConEmu GUI +* Close and restart `Cmder.exe` and `%CMDER_ROOT%\vendor\ConEmu-Maximus5\ConEmu.xml` will be backed up to `%CMDER_ROOT%\config\ConEmu-%COMPUTERNAME%.xml` at startup. + +Example: If `%CMDER_ROOT%\config\ConEmu-%COMPUTERNAME%.xml` exist you can delete the `%CMDER_ROOT%\vendor` folder and copy the contents of a new Cmder binary distribution to `%CMDER_ROOT%`. Launching `cmder.exe` will copy your custom `ConEmu-%COMPUTERNAME%.xml` at startup into the new ConEmu folder and use it to launch ConEmu instead of the default Cmder `ConEmu.xml` file.. + ### Linux like 'profile.d' support for all supported shell types. You can write *.cmd|*.bat, *.ps1, and *.sh scripts and just drop them in the %CMDER_ROOT%\config\profile.d folder to add startup config to Cmder.