Browse Source

update templating doc

deadmoon 2 years ago
parent
commit
77fb54e1c3
1 changed files with 11 additions and 11 deletions
  1. 11 11
      TEMPLATING.md

+ 11 - 11
TEMPLATING.md

@@ -6,18 +6,18 @@ Then, execute it like this: ```optimizer.exe /config=template.json```
 ### Download the template: ###
 ### Download the template: ###
 https://github.com/hellzerg/optimizer/blob/master/templates/optimizer-template.json
 https://github.com/hellzerg/optimizer/blob/master/templates/optimizer-template.json
 
 
-#### WindowsVersion (required) ####
+### WindowsVersion (required) ###
 * Should match your actual Windows version. Available values: ```7 | 8 | 10 | 11```
 * Should match your actual Windows version. Available values: ```7 | 8 | 10 | 11```
 
 
-#### Cleaner ####
+### Cleaner ###
 * Choose which target folder you wish to clean by marking ```true```
 * Choose which target folder you wish to clean by marking ```true```
 
 
-#### Pinger ####
+### Pinger ###
 * Choose your desired DNS provider.
 * Choose your desired DNS provider.
 * Available values: ```Automatic | Cloudflare | OpenDNS | Quad9 | Google | AlternateDNS | Adguard | CleanBrowsing | CleanBrowsing (adult filter)```
 * Available values: ```Automatic | Cloudflare | OpenDNS | Quad9 | Google | AlternateDNS | Adguard | CleanBrowsing | CleanBrowsing (adult filter)```
 * If you wish to perform DNS cache flushing, set it to ```true```
 * If you wish to perform DNS cache flushing, set it to ```true```
 
 
-#### ProcessControl ####
+### ProcessControl ###
 * Choose which processes you wish to prevent from running, using their filename.
 * Choose which processes you wish to prevent from running, using their filename.
 * You can remove previously prevented processes, in order to allow them to run again.
 * You can remove previously prevented processes, in order to allow them to run again.
 * Example: 
 * Example: 
@@ -28,7 +28,7 @@ https://github.com/hellzerg/optimizer/blob/master/templates/optimizer-template.j
 }
 }
 ```
 ```
 
 
-#### Hosts ####
+### Hosts ###
 * Control your hosts entries. ```Add``` list adds the entries, ```Block``` list routes the entries to ```0.0.0.0``` effectively blocking access to them.
 * Control your hosts entries. ```Add``` list adds the entries, ```Block``` list routes the entries to ```0.0.0.0``` effectively blocking access to them.
 * Example:
 * Example:
 ```
 ```
@@ -49,31 +49,31 @@ https://github.com/hellzerg/optimizer/blob/master/templates/optimizer-template.j
 }	
 }	
 ```
 ```
 
 
-#### RegistryFix ####
+### RegistryFix ###
 * You can try enabling core Windows components by marking them ```true```
 * You can try enabling core Windows components by marking them ```true```
 * You typically do not need this, unless you are trying to repair a computer from malicious actions
 * You typically do not need this, unless you are trying to repair a computer from malicious actions
 
 
-#### Integrator ####
+### Integrator ###
 * ```TakeOwnership```: Mark ```true``` to add a "Take Ownership" option in right-click menu. Remove it by marking ```false```
 * ```TakeOwnership```: Mark ```true``` to add a "Take Ownership" option in right-click menu. Remove it by marking ```false```
 * ```OpenWithCMD```: Mark ```true``` to add a "Open CMD here" option in right-click menu. Remove it by marking ```false```
 * ```OpenWithCMD```: Mark ```true``` to add a "Open CMD here" option in right-click menu. Remove it by marking ```false```
 
 
-#### AdvancedTweaks ####
+### AdvancedTweaks ###
 * Deeply technical tweaks that you should NOT touch, unless you know what you are really doing
 * Deeply technical tweaks that you should NOT touch, unless you know what you are really doing
 
 
 * ```UnlockAllCores```: DO NOT use this option. Leave it ```null``` or ```false```.
 * ```UnlockAllCores```: DO NOT use this option. Leave it ```null``` or ```false```.
 * ```DisableHPET```: Enables or disables High Precision Event Timer.
 * ```DisableHPET```: Enables or disables High Precision Event Timer.
 * ```EnableLoginVerbose```: Enables or disables Detailed Login Screen
 * ```EnableLoginVerbose```: Enables or disables Detailed Login Screen
 
 
-##### SvchostProcessSplitting #####
+#### SvchostProcessSplitting ####
 * Mark it ```true``` and set the amount of ```RAM``` to reduce the svchost.exe processes for optimal memory
 * Mark it ```true``` and set the amount of ```RAM``` to reduce the svchost.exe processes for optimal memory
 * Mark it ```false``` to enable process splitting for optimal performance
 * Mark it ```false``` to enable process splitting for optimal performance
 
 
-#### Tweaks ####
+### Tweaks ###
 * Mark the options you want to APPLY to ```true```
 * Mark the options you want to APPLY to ```true```
 * Mark the options you want to RESET to ```false```
 * Mark the options you want to RESET to ```false```
 * Mark the options you want to IGNORE to ```null```
 * Mark the options you want to IGNORE to ```null```
 
 
-#### PostAction ####
+### PostAction ###
 * Final action after executing the template.
 * Final action after executing the template.
 * You may mark ```Restart``` to ```true``` to restart in order to effectively apply the changes.
 * You may mark ```Restart``` to ```true``` to restart in order to effectively apply the changes.
 * You may choose between different types of restarting by configuring ```RestartType```
 * You may choose between different types of restarting by configuring ```RestartType```