Skip to content

Commit 0756dc8

Browse files
committed
platform compatibility
1 parent e9aeaaa commit 0756dc8

File tree

1 file changed

+59
-11
lines changed

1 file changed

+59
-11
lines changed

README.md

Lines changed: 59 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -179,13 +179,7 @@ If you need to move a project, use `claude-migrate-project` to update the conver
179179

180180
### 🔐 Optional Encryption
181181

182-
Enable transparent encryption with git-crypt:
183-
184-
```bash
185-
# Install git-crypt
186-
sudo apt install git-crypt # Ubuntu/Debian
187-
brew install git-crypt # macOS
188-
```
182+
Enable transparent encryption with git-crypt. See [Requirements](#installing-git-crypt-for-encryption) section for installation on your platform.
189183

190184
**First machine (enable encryption):**
191185
```bash
@@ -367,16 +361,70 @@ mv /home/user/old-name /home/user/new-name
367361

368362
## Requirements
369363

364+
### Core Dependencies
370365
- Bash 4.0+
371366
- Git
372367
- rsync
373368
- tar, gzip
374369
- git-crypt (optional, for encryption)
375370

376-
**Supported platforms:**
377-
- Linux (Ubuntu, Debian, Fedora, Arch, etc.)
378-
- macOS
379-
- Windows (WSL)
371+
### Platform Support
372+
373+
**✅ Linux (Tested & Recommended)**
374+
- Ubuntu/Debian - Fully tested and working
375+
- Fedora/RHEL/CentOS - Should work (standard bash/git/rsync)
376+
- Arch Linux - Should work
377+
- Pop!_OS - Should work (Ubuntu-based)
378+
379+
All standard Linux distributions with bash 4.0+ should work out of the box.
380+
381+
**✅ macOS (Should Work)**
382+
- macOS 10.14+ - Should work
383+
- Comes with bash, git, rsync by default
384+
- May need to install git-crypt via Homebrew
385+
- Note: Default shell is zsh, but bash scripts run fine
386+
387+
**✅ Windows WSL (Should Work)**
388+
- WSL 1 or WSL 2 with Ubuntu/Debian - Should work
389+
- Treats WSL as a Linux environment
390+
- All Linux instructions apply
391+
392+
**❌ Windows Native (Not Supported)**
393+
- Git Bash - Limited support, not recommended
394+
- PowerShell - Not compatible (bash scripts only)
395+
- Native Windows - Not supported
396+
397+
### Installing git-crypt (for encryption)
398+
399+
**Ubuntu/Debian/Pop!_OS:**
400+
```bash
401+
sudo apt update
402+
sudo apt install git-crypt
403+
```
404+
405+
**Fedora/RHEL/CentOS:**
406+
```bash
407+
sudo dnf install git-crypt # Fedora/RHEL 8+
408+
# OR
409+
sudo yum install git-crypt # CentOS/RHEL 7
410+
```
411+
412+
**Arch Linux:**
413+
```bash
414+
sudo pacman -S git-crypt
415+
```
416+
417+
**macOS:**
418+
```bash
419+
brew install git-crypt
420+
```
421+
422+
**Windows WSL:**
423+
Use the Linux distribution's package manager (usually `apt` for Ubuntu):
424+
```bash
425+
sudo apt update
426+
sudo apt install git-crypt
427+
```
380428

381429
## Contributing
382430

0 commit comments

Comments
 (0)