swadhin / lsf public

docs(install): fix GitHub owner to swadhinbiswas and clarify both lsf and column.py are required; remove pipe-to-bash in quick reference

swadhin biswas committed 1 years ago
f76bb3a
1 parent 7633f9f
commit f76bb3a
6 files changed
+21 -27
Showing 6 changed files+21-27
CODE_OF_CONDUCT.mdQUICK_REFERENCE.mdREADME.mdSECURITY.mddocs/INSTALLATION.mdindex.html
▼CODE_OF_CONDUCT.md
+1-1
@@ -29,7 +29,7 @@ Project maintainers are responsible for clarifying and enforcing our standards.
29
29
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the maintainers.
30
30
31
31
- Prefer using GitHub’s private “Report a vulnerability”/contact options when applicable
32
-- Or contact the maintainer via their GitHub profile: @swadhin-biswas
32
+- Or contact the maintainer via their GitHub profile: @swadhinbiswas
33
33
34
34
All complaints will be reviewed and investigated promptly and fairly.
35
35
36
36
▼QUICK_REFERENCE.md
+2-2
@@ -13,8 +13,8 @@ A one-page cheat sheet for **ls-f** users and developers.
13
13
# System install (requires sudo)
14
14
sudo ./install.sh --system
15
15
16
-# Or one-liner
17
-curl -fsSL https://raw.githubusercontent.com/swadhin-biswas/ls-f/main/install.sh | bash
16
+# Or clone one-liner (recommended)
17
+git clone https://github.com/swadhinbiswas/ls-f.git && cd ls-f && ./install.sh --user
18
18
```
19
19
20
20
---
21
21
▼README.md
+2-0
@@ -30,6 +30,8 @@ cd ls-f
30
30
./install.sh --user # or: sudo ./install.sh --system
31
31
```
32
32
33
+Note: lsf uses a small Python helper (`column.py`) for grid formatting. The installer installs both `lsf` and `column.py`. If installing manually, make sure both are present in your PATH.
34
+
33
35
### Optional: Alias `ls`
34
36
```bash
35
37
echo "alias ls='lsf'" >> ~/.zshrc # or ~/.bashrc, ~/.config/fish/config.fish, ...
36
38
▼SECURITY.md
+1-1
@@ -7,7 +7,7 @@ We support the latest release on the `main` branch (e.g., v4.5.x). Older release
7
7
Please do not open public GitHub issues for security problems.
8
8
9
9
- Use GitHub’s “Report a vulnerability” (Security Advisory) feature if available for this repository
10
-- Alternatively, contact the maintainer privately via their GitHub profile (@swadhin-biswas)
10
+- Alternatively, contact the maintainer privately via their GitHub profile (@swadhinbiswas)
11
11
12
12
Provide as much detail as possible:
13
13
- Affected version(s) and environment (OS, shell)
14
14
▼docs/INSTALLATION.md
+8-16
@@ -33,7 +33,7 @@ If you don't have Nerd Fonts, download from [nerdfonts.com](https://www.nerdfont
33
33
---
34
34
35
35
## 🚀 Installation Methods
36
-
36
+git clone https://github.com/swadhinbiswas/ls-f.git
37
37
### Method 1: Git Clone (Recommended)
38
38
39
39
This method gives you the latest development version.
@@ -54,20 +54,20 @@ sudo ./install.sh --system
54
54
lsf --version
55
55
lsf -x
56
56
```
57
-
57
+sudo ./install.sh --system
58
58
### Method 2: Direct Download
59
59
60
60
# Verify installation
61
61
lsf --version
62
-lsf -x
62
+ Download both scripts directly from GitHub:
63
63
```
64
64
65
65
### Method 2: Direct Download
66
-
66
+sudo curl -fL https://raw.githubusercontent.com/swadhinbiswas/ls-f/main/lsf \
67
67
Download both scripts directly from GitHub:
68
68
69
69
```bash
70
-# Download lsf to /usr/local/bin (requires sudo)
70
+sudo curl -fL https://raw.githubusercontent.com/swadhinbiswas/ls-f/main/column.py \
71
71
sudo curl -fL https://raw.githubusercontent.com/swadhin-biswas/ls-f/main/lsf \
72
72
-o /usr/local/bin/lsf
73
73
@@ -77,10 +77,10 @@ sudo curl -fL https://raw.githubusercontent.com/swadhin-biswas/ls-f/main/column.
77
77
78
78
# Make both executable
79
79
sudo chmod +x /usr/local/bin/lsf /usr/local/bin/column.py
80
-
80
+git clone https://github.com/swadhinbiswas/ls-f.git && cd ls-f && ./install.sh --user
81
81
# Create config directory
82
82
mkdir -p ~/.config/lsf
83
-
83
+git clone https://github.com/swadhinbiswas/ls-f.git && cd ls-f && sudo ./install.sh --system
84
84
# Verify installation
85
85
lsf --version
86
86
lsf -x
@@ -89,11 +89,10 @@ lsf -x
89
89
### Method 3: One-Liner Installation
90
90
91
91
Clone and install in a single command:
92
-
92
+git clone https://github.com/swadhinbiswas/ls-f.git
93
93
```bash
94
94
# User installation (no sudo needed)
95
95
git clone https://github.com/swadhin-biswas/ls-f.git && cd ls-f && ./install.sh --user
96
-
97
96
# System-wide installation
98
97
git clone https://github.com/swadhin-biswas/ls-f.git && cd ls-f && sudo ./install.sh --system
99
98
```
@@ -176,7 +175,6 @@ sudo ./install.sh --system --replace-ls
176
175
### Verify Installation
177
176
178
177
```bash
179
-# Check if lsf is in PATH
180
178
which lsf
181
179
182
180
# Test basic functionality
@@ -261,7 +259,6 @@ source config/lsf_alias_setup.sh
261
259
**Problem:** Can't write to installation directory.
262
260
263
261
**Solution:** Use sudo for system install:
264
-```bash
265
262
sudo ./install.sh --system
266
263
```
267
264
@@ -277,7 +274,6 @@ Or use user install:
277
274
**Solution (User Install):**
278
275
279
276
Add `~/.local/bin` to your PATH:
280
-
281
277
```bash
282
278
# For Bash - add to ~/.bashrc
283
279
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
@@ -316,13 +312,9 @@ cd ls-f
316
312
sudo apt install python3
317
313
318
314
# Fedora/RHEL
319
-sudo dnf install python3
320
315
321
316
# macOS
322
317
brew install python3
323
-```
324
-
325
-### Nerd Fonts Not Installed
326
318
327
319
**Problem:** Icons show as boxes or question marks.
328
320
329
321
▼index.html
+7-7
@@ -508,7 +508,7 @@
508
508
<div class="hero-buttons">
509
509
<a href="#installation" class="btn btn-primary">Get Started</a>
510
510
<a href="#features" class="btn btn-secondary">Learn More</a>
511
- <a href="https://github.com/swadhin-biswas/ls-f" class="btn btn-primary">GitHub Repo</a>
511
+ <a href="https://github.com/swadhinbiswas/ls-f" class="btn btn-primary">GitHub Repo</a>
512
512
</div>
513
513
</div>
514
514
</header>
@@ -586,7 +586,7 @@ $ lsf -l<br>
586
586
<div class="method-card">
587
587
<h3>Method 1: Git Clone</h3>
588
588
<p>Recommended for latest features</p>
589
- <pre>git clone https://github.com/swadhin-biswas/ls-f.git
589
+ <pre>git clone https://github.com/swadhinbiswas/ls-f.git
590
590
cd ls-f
591
591
./install.sh --user
592
592
@@ -597,16 +597,16 @@ lsf -x</pre>
597
597
<div class="method-card">
598
598
<h3>Method 2: One-Liner</h3>
599
599
<p>Clone and install in one step</p>
600
- <pre>git clone https://github.com/swadhin-biswas/\
600
+ <pre>git clone https://github.com/swadhinbiswas/\
601
601
ls-f.git && cd ls-f && ./install.sh --user</pre>
602
602
</div>
603
603
<div class="method-card">
604
604
<h3>Method 3: Direct Download</h3>
605
605
<p>Download both files manually</p>
606
606
<pre>sudo curl -fL https://raw.githubusercontent.com/\
607
-swadhin-biswas/ls-f/main/lsf -o /usr/local/bin/lsf
607
+swadhinbiswas/ls-f/main/lsf -o /usr/local/bin/lsf
608
608
sudo curl -fL https://raw.githubusercontent.com/\
609
-swadhin-biswas/ls-f/main/column.py -o /usr/local/bin/column.py
609
+swadhinbiswas/ls-f/main/column.py -o /usr/local/bin/column.py
610
610
sudo chmod +x /usr/local/bin/lsf /usr/local/bin/column.py</pre>
611
611
</div>
612
612
</div>
@@ -790,8 +790,8 @@ COLORS[".json"]="36" # Cyan</pre>
790
790
<p>A beautiful alternative to the standard <code style="background: rgba(255,255,255,0.1); padding: 3px 6px; border-radius: 3px;">ls</code> command with file-type icons.</p>
791
791
792
792
<div class="links">
793
- <a href="https://github.com/swadhin-biswas/ls-f">GitHub</a>
794
- <a href="https://github.com/swadhin-biswas/ls-f/issues">Issues</a>
793
+ <a href="https://github.com/swadhinbiswas/ls-f">GitHub</a>
794
+ <a href="https://github.com/swadhinbiswas/ls-f/issues">Issues</a>
795
795
<a href="docs/INSTALLATION.md">Installation</a>
796
796
<a href="docs/CONFIGURATION.md">Configuration</a>
797
797
<a href="docs/TROUBLESHOOTING.md">Help</a>
798
798