summaryrefslogtreecommitdiff
path: root/BaseTools/Source/Python/README.md
diff options
context:
space:
mode:
authorkx <kx@radix.pro>2024-06-04 06:43:08 +0300
committerkx <kx@radix.pro>2024-06-04 06:43:08 +0300
commit7e2ccccace24636f29ddc210b94606abd4c7e42b (patch)
tree545d43ea12671048956cafeb12303e84d601e571 /BaseTools/Source/Python/README.md
parent27b044605cd5f6b33a3d231576003850b3fe305b (diff)
downloadedk2-trunk.tar.xz
Renormalized end-of-lines from master@27b044605cd5f6b33a3d231576003850b3fe305btrunk
Diffstat (limited to 'BaseTools/Source/Python/README.md')
-rw-r--r--BaseTools/Source/Python/README.md58
1 files changed, 29 insertions, 29 deletions
diff --git a/BaseTools/Source/Python/README.md b/BaseTools/Source/Python/README.md
index 8c4d9e73bb..7266b8f84f 100644
--- a/BaseTools/Source/Python/README.md
+++ b/BaseTools/Source/Python/README.md
@@ -1,29 +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.
+# 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.