Fix ls fully compibility
swadhin biswas committed 1 years ago
e1ffe36
1 parent 82ba778
commit e1ffe36
5 files changed
+2 -104
Showing 5 changed files+2-104
▼IMPLEMENTATION_COMPLETE.md
+0-0
0 | 0 |
▼INSTALL_FIXES.md
+0-102
| @@ -1,102 +0,0 @@ | ||
1 | -# Installation Process Fixes | |
2 | - | |
3 | -## Summary | |
4 | -Fixed installation documentation and scripts to accurately reflect the codebase requirements and proper installation workflow. | |
5 | - | |
6 | -## Changes Made | |
7 | - | |
8 | -### 1. install.sh Improvements | |
9 | -- ✅ Added `SCRIPT_DIR` resolution to find files relative to installer location | |
10 | -- ✅ Added error check to fail fast if `lsf` script not found | |
11 | -- ✅ Updated file paths to use `$SCRIPT_DIR/lsf` and `$SCRIPT_DIR/column.py` | |
12 | -- ✅ Added PATH validation warning when bin directory not in PATH | |
13 | -- ✅ Added post-install verification steps (`lsf --version`, `lsf -x`) | |
14 | -- ✅ Fixed config alias setup reference to use absolute path | |
15 | - | |
16 | -### 2. docs/INSTALLATION.md Updates | |
17 | -- ✅ Added verification steps after Method 1 (git clone) | |
18 | -- ✅ Fixed Method 2 (Direct Download) to include both `lsf` and `column.py` | |
19 | -- ✅ Changed Method 3 from pipe-to-bash to one-liner git clone (installer needs repo files) | |
20 | -- ✅ Added explicit test commands in verification section | |
21 | -- ✅ Clarified automatic alias setup requires being in repo directory | |
22 | -- ✅ Improved PATH troubleshooting with shell-specific echo commands | |
23 | -- ✅ Expanded Python/column.py troubleshooting with multiple solutions | |
24 | -- ✅ Simplified update instructions to focus on git pull workflow | |
25 | - | |
26 | -### 3. index.html Corrections | |
27 | -- ✅ Updated Method 1 card to include verification commands | |
28 | -- ✅ Fixed Method 2 from broken pipe install to working one-liner git clone | |
29 | -- ✅ Updated Method 3 to download both files with proper URLs | |
30 | -- ✅ Expanded usage examples to include new flags: `-A`, `-x`, `-X`, `-Z`, `--zero` | |
31 | - | |
32 | -### 4. README.md Cleanup | |
33 | -- ✅ Verified no duplicate content present | |
34 | -- ✅ Installation instructions already accurate | |
35 | - | |
36 | -## Key Improvements | |
37 | - | |
38 | -### Before | |
39 | -```bash | |
40 | -# Method that doesn't work - missing column.py | |
41 | -curl -fsSL https://raw.githubusercontent.com/swadhin-biswas/ls-f/main/install.sh | sudo bash | |
42 | -``` | |
43 | - | |
44 | -### After | |
45 | -```bash | |
46 | -# Working method - gets all files | |
47 | -git clone https://github.com/swadhin-biswas/ls-f.git && cd ls-f && ./install.sh --user | |
48 | -``` | |
49 | - | |
50 | -## Verification Workflow | |
51 | - | |
52 | -After installation, users should run: | |
53 | -```bash | |
54 | -lsf --version # Confirms lsf is installed and in PATH | |
55 | -lsf -x # Demonstrates icon functionality | |
56 | -``` | |
57 | - | |
58 | -## Installation Methods Now | |
59 | - | |
60 | -### Method 1: Git Clone (Recommended) | |
61 | -```bash | |
62 | -git clone https://github.com/swadhin-biswas/ls-f.git | |
63 | -cd ls-f | |
64 | -./install.sh --user # or sudo ./install.sh --system | |
65 | - | |
66 | -# Verify | |
67 | -lsf --version | |
68 | -lsf -x | |
69 | -``` | |
70 | - | |
71 | -### Method 2: One-Liner | |
72 | -```bash | |
73 | -git clone https://github.com/swadhin-biswas/ls-f.git && cd ls-f && ./install.sh --user | |
74 | -``` | |
75 | - | |
76 | -### Method 3: Direct Download | |
77 | -```bash | |
78 | -sudo curl -fL https://raw.githubusercontent.com/swadhin-biswas/ls-f/main/lsf -o /usr/local/bin/lsf | |
79 | -sudo curl -fL https://raw.githubusercontent.com/swadhin-biswas/ls-f/main/column.py -o /usr/local/bin/column.py | |
80 | -sudo chmod +x /usr/local/bin/lsf /usr/local/bin/column.py | |
81 | -mkdir -p ~/.config/lsf | |
82 | -``` | |
83 | - | |
84 | -## Files Modified | |
85 | -- `install.sh` - Enhanced with path resolution, validation, and verification steps | |
86 | -- `docs/INSTALLATION.md` - Corrected all methods and improved troubleshooting | |
87 | -- `index.html` - Fixed installation cards and expanded usage examples | |
88 | -- Created this summary document | |
89 | - | |
90 | -## Testing | |
91 | -All installation methods tested and verified: | |
92 | -- ✅ `./install.sh --help` shows correct options | |
93 | -- ✅ `./lsf --version` returns `lsf version 4.5.0` | |
94 | -- ✅ `./lsf -x` displays horizontal icon layout | |
95 | -- ✅ Installer validates files exist before proceeding | |
96 | - | |
97 | -## Next Steps for Users | |
98 | -1. Clone the repository | |
99 | -2. Run `./install.sh --user` (or with `--system`) | |
100 | -3. Verify with `lsf --version` and `lsf -x` | |
101 | -4. Optionally set alias: `alias ls='lsf'` | |
102 | -5. Customize icons in `~/.config/lsf/lsf.conf` | |
103 | 0 | |
▼QUICK_REFERENCE.md
+2-2
| @@ -226,7 +226,7 @@ alias | grep ls | ||
226 | 226 | |
227 | 227 | ## 🆘 Getting Help |
228 | 228 | |
229 | -- **GitHub Issues:** https://github.com/swadhin-biswas/ls-f/issues | |
229 | +- **GitHub Issues:** https://github.com/swadhinbiswas/ls-f/issues | |
230 | 230 | - **Documentation:** See `docs/` folder |
231 | 231 | - **FAQ:** Open `index.html` in browser |
232 | 232 | |
| @@ -239,4 +239,4 @@ MIT License — Use freely, modify, and redistribute. | ||
239 | 239 | --- |
240 | 240 | |
241 | 241 | **Last updated: October 16, 2025** |
242 | -For latest docs, visit: https://github.com/swadhin-biswas/ls-f | |
242 | +For latest docs, visit: https://github.com/swadhinbiswas/ls-f | |
243 | 243 | |
▼docs/example.png
+0-0
Binary file not shown.
▼docs/image.png
+0-0
Binary file not shown.