diff options
| author | Matthew Carlson <matthewfcarlson@gmail.com> | 2021-02-09 08:50:33 +0800 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2021-02-09 03:56:37 +0000 |
| commit | 1534b6228b0932d745bf6ec9fd4cb010800b92f2 (patch) | |
| tree | 72fff77178550a5f65df459f1b639a09efa499f9 /BaseTools/Source/Python/README.md | |
| parent | ecc267fec55aecd9e36bf80caba732d5121a3428 (diff) | |
| download | edk2-1534b6228b0932d745bf6ec9fd4cb010800b92f2.tar.gz edk2-1534b6228b0932d745bf6ec9fd4cb010800b92f2.tar.bz2 edk2-1534b6228b0932d745bf6ec9fd4cb010800b92f2.zip | |
BaseTools: Use pip module if available, CI uses it by default
Use the new edk2-basetools pip module.
Includes a helpful message in setup to let users know which has been
selected.
Cc: Bob Feng <bob.c.feng@intel.com>
Cc: Liming Gao <gaoliming@byosoft.com.cn>
Cc: Yuwei Chen <yuwei.chen@intel.com>
Reviewed-by: Bob Feng <bob.c.feng@intel.com>
Reviewed-by: Yuwei <Chen<yuwei.chen@intel.com>
Signed-off-by: Matthew Carlson <matthewfcarlson@gmail.com>
Diffstat (limited to 'BaseTools/Source/Python/README.md')
| -rw-r--r-- | BaseTools/Source/Python/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/BaseTools/Source/Python/README.md b/BaseTools/Source/Python/README.md new file mode 100644 index 0000000000..8c4d9e73bb --- /dev/null +++ b/BaseTools/Source/Python/README.md @@ -0,0 +1,29 @@ +# Edk2 Basetools
+
+This folder has traditionally held the source of Python based tools used by EDK2.
+The official repo this source has moved to https://github.com/tianocore/edk2-basetools.
+This folder will remain in the tree until the next stable release (expected 202102).
+There is a new folder under Basetools `BinPipWrappers` that uses the pip module rather than this tree for Basetools.
+By adding the scope `pipbuild-win` or `pipbuild-unix` (depending on your host system), the SDE will use the
+`BinPipWrappers` instead of the regular `BinWrappers`.
+
+## Why Move It?
+
+The discussion is on the mailing list. The RFC is here: https://edk2.groups.io/g/rfc/topic/74009714#270
+The benefits allow for the Basetools project to be used separately from EDK2 itself as well as offering it in a
+globally accessible manner.
+This makes it much easier to build a module using Basetools.
+Separating the Basetools into their own repo allows for easier CI and contribution process.
+Additional pros, cons, and process can be found on the mailing list.
+
+## How Do I Install It?
+
+By default, EDK2 is tied to and tested with a specific version of the Basetools through `pip-requirements.txt`.
+You can simply run:
+
+```bash
+pip install -r pip-requirements.txt
+```
+
+This will install the required module, thought we strongly suggest setting up a virtual environment.
+Additionally, you can also install a local clone of the Basetools as well as a specific git commit.
|