docs: add Git LFS & Xet setup instructions to README
Browse files
README.md
CHANGED
|
@@ -93,6 +93,24 @@ ln -sf dist/codev ~/.local/bin/codev
|
|
| 93 |
# then can use Codev in everywhere after `/login`
|
| 94 |
```
|
| 95 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 96 |
## 🚀 Quick Start
|
| 97 |
|
| 98 |
> [!IMPORTANT]
|
|
|
|
| 93 |
# then can use Codev in everywhere after `/login`
|
| 94 |
```
|
| 95 |
|
| 96 |
+
### Git LFS & Xet (faster large-file transfer)
|
| 97 |
+
|
| 98 |
+
Asset files (images, screenshots) are tracked via Git LFS.
|
| 99 |
+
Install the **git-xet** custom transfer agent to replace the standard LFS protocol with
|
| 100 |
+
Xet's chunk-dedup transport for much faster push/pull:
|
| 101 |
+
|
| 102 |
+
```bash
|
| 103 |
+
curl --proto '=https' --tlsv1.2 -sSf \
|
| 104 |
+
https://raw.githubusercontent.com/huggingface/xet-core/refs/heads/main/git_xet/install.sh | sh
|
| 105 |
+
git xet install
|
| 106 |
+
```
|
| 107 |
+
|
| 108 |
+
After setup, use normal git workflow — `git-xet` automatically handles LFS objects:
|
| 109 |
+
|
| 110 |
+
```bash
|
| 111 |
+
git lfs pull # download all large files
|
| 112 |
+
```
|
| 113 |
+
|
| 114 |
## 🚀 Quick Start
|
| 115 |
|
| 116 |
> [!IMPORTANT]
|