Update README.md

This commit is contained in:
Fierelier 2022-06-28 08:22:12 +02:00
parent 7fb6657378
commit cb01674406
1 changed files with 14 additions and 9 deletions

View File

@ -10,24 +10,27 @@ A windows homebrew kit and collection of mods. Can mod .WIM (this is where main-
* **Python:** https://www.python.org/downloads/ (Get 3.8.* if you're on 7, devs are soy)
* **colorama** (optional)**:** `py -m pip install colorama`
* **wimlib:** https://wimlib.net/ (if working with .WIMs)
* **Something to run the script as SYSTEM and TrustedInstaller:** There isn't much good software to do this with, especially the TrustedInstaller part. This is okay: https://www.nirsoft.net/utils/advanced_run.html -- But it's not open source ([*1](#notes))
## How to use - Simple
Extract both wimlib and AdvancedRun to `Path\` (the folder is only added to %path% if you use `run.bat`). Both `AdvancedRun.exe` and `wimlib-imagex.exe` should be in the main `Path\` folder, alongside their libraries.
## How to use - Simple (Online)
Drag `run-online.bat` into `ti-shell.bat`. It will use [RunAsTI](https://github.com/AveYo/LeanAndMean/blob/main/RunAsTI.bat) to execute `run.py`, and apply all mods to your currently running system. If you want to know how it works, edit the .bat file.
Run `run.bat`. It will use AdvancedRun to execute `run.py`, and apply all mods to your wished for wim file. It will do two runs, one as SYSTEM, and another as TrustedInstaller. Both runs have different mods. If you want to know how it works, edit the .bat file.
## How to use - Simple (.WIM)
Extract wimlib to `Path\` (the folder is only added to %path% if you use `ti-shell.bat`). `wimlib-imagex.exe` should be in the main `Path\` folder, alongside their libraries.
Drag `run-wim.bat` into `ti-shell.bat`. It will use [RunAsTI](https://github.com/AveYo/LeanAndMean/blob/main/RunAsTI.bat) to execute `run.py`, and apply all mods to your wished for wim file. If you want to know how it works, edit the .bat file.
If Python shows no exceptions, the script likely ran successfully.
If you want to edit offline media, or batch-process .WIMs, move on to [How to use - Advanced](#how-to-use-advanced).
### Arguments:
`run.bat "wimpath" 1`
`run-wim.bat "wimpath" 1`
Replace `wimpath` with the path to your .wim, and `1` with the index you want to modify, * for all. Both arguments are optional, though you cannot define an index without a wim. If you run the batch without any arguments, you will be asked for some.
## How to use - Advanced
Run `run.py` with some arguments, as SYSTEM or TrustedInstaller. Arguments work like this: `arg="value"`. If working with .WIMs, make sure [wimlib](https://wimlib.net/) is in your %path%.
Execute `ti-shell.bat` to elevate to TrustedInstaller. Now execute `run.py` with some arguments, as SYSTEM or TrustedInstaller. Arguments work like this: `arg="value"`. If working with .WIMs, make sure [wimlib](https://wimlib.net/) is in your %path%.
### Arguments - .WIM:
* **wim:** Point to a wim file (**required**)
@ -41,10 +44,12 @@ Run `run.py` with some arguments, as SYSTEM or TrustedInstaller. Arguments work
**Example:** `run.py path="D:"` - Applies tweaks to `D:\`.
### Arguments - Online:
None.
**Example:** `run.py online`
### Arguments - General:
* **modpath:** Folder to source mods from.
**Example:** `run.py modpath="mods-trustedInstaller" wim="E:\sources\install.wim" index=*` - Apply mods that require to be executed by TrustedInstaller to all indexes of `E:\sources\install.wim`.
## Notes
**\*1:** Blame M$. Terry said something amongst the lines of "File permissions don't belong in a user operating system" - I think it's good enough if you have a user that has permissions over everything. Vista and up do not have this, for some reason.