Author SHA1 Message Date
ImgBotApp 55969646d9 [ImgBot] Optimize images
*Total -- 2,147.42kb -> 1,785.18kb (16.87%)

/.github/images/icons.png -- 532.52kb -> 401.99kb (24.51%)
/.github/images/logo-ls.png -- 410.71kb -> 322.93kb (21.37%)
/.github/images/ls-l.png -- 185.62kb -> 148.00kb (20.27%)
/.github/images/ls-h.png -- 130.12kb -> 112.42kb (13.6%)
/.github/images/ls-R.png -- 120.74kb -> 106.92kb (11.45%)
/.github/images/ls-T.png -- 170.18kb -> 151.52kb (10.96%)
/.github/images/ls-c.png -- 51.14kb -> 45.69kb (10.67%)
/.github/images/ls multi.png -- 58.41kb -> 52.52kb (10.08%)
/.github/images/ls-a.png -- 62.14kb -> 56.00kb (9.87%)
/.github/images/ls-1.png -- 68.30kb -> 61.61kb (9.8%)
/.github/images/ls-AshDt.png -- 88.17kb -> 79.67kb (9.64%)
/.github/images/ls-A.png -- 59.34kb -> 53.82kb (9.32%)
/.github/images/ls.png -- 49.90kb -> 45.47kb (8.88%)
/.github/images/ls-X.png -- 56.57kb -> 51.75kb (8.51%)
/.github/images/ls-D.png -- 54.93kb -> 50.30kb (8.42%)
/.github/images/ls-i.png -- 48.62kb -> 44.56kb (8.35%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
2020-09-10 09:35:21 +00:00
Yash-Handa fc190fe213 Updated some images 2020-09-10 15:04:53 +05:30
Yash-Handa 325ede6a51 Added images to README.md 2020-09-10 14:40:27 +05:30
Yash-Handa 8476463bd1 added synopsis to ctw 2020-09-10 13:32:23 +05:30
Yash-Handa 66065a3e1c Add 14 linux based icons 2020-09-10 13:24:05 +05:30
Yash-Handa c6ef105c5c added some emojies to README.md 2020-09-10 12:03:04 +05:30
Yash HandaandGitHub 6ed2b350c8 Update README.md 2020-09-10 11:53:29 +05:30
Yash-Handa f8d272d2c4 Added other sections to README.md 2020-09-10 11:39:43 +05:30
Yash-Handa b93c27db79 Added TOC link to sections of README.md 2020-09-10 08:14:10 +05:30
Yash-Handa 01424c6d9d added Installation Section to README.md 2020-09-10 08:08:34 +05:30
Yash HandaandGitHub ead801831f Merge pull request #2 from Yash-Handa/add-code-of-conduct-1
Create CODE_OF_CONDUCT.md
2020-09-09 11:04:29 +05:30
25 changed files with 284 additions and 51 deletions
Binary file not shown.

Before

Width:  |  Height:  |  Size: 532 KiB

After

Width:  |  Height:  |  Size: 402 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 411 KiB

After

Width:  |  Height:  |  Size: 323 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 172 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 46 KiB

+263 -51
View File
@@ -15,6 +15,12 @@
modern ls command with beautiful Icons and Git Integrations . Written in Golang
<div>
<span align="center">
<img alt="logo-ls" title="logo-ls" src="/.github/images/ls.png">
</span>
</div><br>
Command and Arguments supported are listed in [HELP.md](/HELP.md)
## Table of contents
@@ -36,29 +42,38 @@ Command and Arguments supported are listed in [HELP.md](/HELP.md)
- `-c` (or) `--disable-color`
- [Combination of flags](#combination-of-flags)
- [Multiple Files and Directories](#multiple-files-and-directories)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Debian (.deb package)](#debian-deb-package)
- [Red Hat (.rpm package)](#red-hat-rpm-package)
- [MacOS (Darwin)](#macos-darwin)
- [Linux](#linux)
- [Check the downloaded Resource](#check-the-downloaded-resource)
- [Recommended configurations](#recommended-configurations)
- [Updating](#updating)
- [Uninstallation](#uninstallation)
- [Icon Set](#icon-set)
- [Contributing](#contributing)
- [License](#license)
## Features
[:arrow_up: TOC](#table-of-contents)
This project is build to add esthetics to ls(coreutiles) command
- Over 250+ icons
- Over 250+ icons :sunglasses:
- Supporting 600+ files, extensions and directories
- 16 Million, true colors supported
- Git Status Integration
- Near native speed. (thanks to Golang)
- :racehorse: Near native speed. (thanks to Golang)
- Language agnostic binaries
This project is highly inspired by [ls(coreutiles)](https://www.gnu.org/software/coreutils/manual/html_node/ls-invocation.html#ls-invocation) and [color ls](https://github.com/athityakumar/colorls). The project tries to find a happy path between speed and aesthetics.
## Usage
[:arrow_up: TOC](#table-of-contents)
All supported flags can be found by using help flag `$ logo-ls -?`. The same has been provided as [HELP.md](/HELP.md).
The project also has its manpage which can be accessed by `man logo-ls`
@@ -68,18 +83,67 @@ The project also has its manpage which can be accessed by `man logo-ls`
Almost all flags are same as that of the classic ls command and behave similarly. The project can be used as a drop-in replacement for the ls(coreutiles)
- With `-1`: List one entry per line
<div>
<span align="center">
<img alt="logo-ls -1" title="logo-ls -1" src="/.github/images/ls-1.png">
</span>
</div><br>
- With `-a` (or) `--all` : Does not ignore entries starting with '.'
<div>
<span align="center">
<img alt="logo-ls -a" title="logo-ls -a" src="/.github/images/ls-a.png">
</span>
</div><br>
- With `-A` (or) `--almost-all` : Does not ignore entries starting with '.', except `./` and `../`
<div>
<span align="center">
<img alt="logo-ls -A" title="logo-ls -A" src="/.github/images/ls-A.png">
</span>
</div><br>
- With `-D` (or) `--git-status`: Add Git Status to the listed Files and Directory
- *Note*: As much I would love to make this the default behavior of the command but showing git status is an intensive task and may slow (a tiny bit) the command itself. If you want you can make alias to the command with `-D` applied to it.
<div>
<span align="center">
<img alt="logo-ls -D" title="logo-ls -D" src="/.github/images/ls-D.png">
</span>
</div><br>
- With `-l`: Shows in long listing format
other similar commands are:
- `-o`: like `-l`, but do not list group information
- `-g`: like `-l`, but do not list owner
- `-G` (or) `--no-group`: in a long listing, don't print group names
<div>
<span align="center">
<img alt="logo-ls -l" title="logo-ls -l" src="/.github/images/ls-l.png">
</span>
</div><br>
- With `-R` (or) `--recursive`: list subdirectories recursively
<div>
<span align="center">
<img alt="logo-ls -R" title="logo-ls -R" src="/.github/images/ls-R.png">
</span>
</div><br>
- With `-?` (or) `--help`: print the help message
- similar message can be found at [HELP.md](/HELP.md).
<div>
<span align="center">
<img alt="logo-ls -?" title="logo-ls -?" src="/.github/images/ls-h.png">
</span>
</div><br>
- **Sorting**: There are many sorting flags available [default is *alphabetic order*]
- With `-t`: sort by modification time, newest first
- With `-S`: sort by file size, largest first
@@ -87,24 +151,184 @@ Almost all flags are same as that of the classic ls command and behave similarly
- With `-U`: do not sort; list entries in directory order
- With `-v`: natural sort of (version) numbers within text
- With `-r` (or) `-reverse`: reverse order while sorting
<div>
<span align="center">
<img alt="logo-ls -X" title="logo-ls -X" src="/.github/images/ls-X.png">
</span>
</div><br>
- With `-T` (or) `--time-style=value`: set time/date format in long formats (`-l`, `-o`, `-g`). There are many options to chose from all are listed in [HELP.md](/HELP.md).
<div>
<span align="center">
<img alt="logo-ls -T" title="logo-ls -T" src="/.github/images/ls-T.png">
</span>
</div><br>
- With `-i` (or) `--disable-icon`: don't print icons of the files
<div>
<span align="center">
<img alt="logo-ls -i" title="logo-ls -i" src="/.github/images/ls-i.png">
</span>
</div><br>
- With `-c` (or) `--disable-color`: don't color icons, filenames and git status
- *Note*: use a combination of `-ic` to print output to a file `$ logo-ls -ic > t.txt`
<div>
<span align="center">
<img alt="logo-ls -c" title="logo-ls -c" src="/.github/images/ls-c.png">
</span>
</div><br>
For all available commands see manpage or [HELP.md](/HELP.md)
### Combination of flags
This project uses [getopt](https://github.com/pborman/getopt) which is a golang variant of the classic getopt utility used in ls(coreutiles). Thus any combination of flags are possible and can be used.
<div>
<span align="center">
<img alt="logo-ls with flag combination" title="logo-ls with flag combination" src="/.github/images/ls-AshDt.png">
</span>
</div><br>
### Multiple Files and Directories
You can provide multiple files and directories as command argument [default to PWD] and all will be displayed accordingly.
<div>
<span align="center">
<img alt="logo-ls with multiple files" title="logo-ls with multiple files" src="/.github/images/ls multi.png">
</span>
</div><br>
## Prerequisites
[:arrow_up: TOC](#table-of-contents)
For proper working of `logo-ls` the following should be set
- **UTF-8**: The terminal should be UTF-8 encoded (Can display Unicode-Code Point)
- **True Color** Support: The terminal can display color (16 Million Colors). for more information of True Color and supported Terminals [see here](https://gist.github.com/XVilka/8346728)
- **Nerd Fonts**: Nerd fonts are required to display Icons on screen. Basically Nerd Fonts patches your current font i.e., the last few unicode points (approx 2,824 out of 143,859) in the font are replaced with nerdy icons :nerd_face:. The complete patching process is given [here](https://github.com/ryanoasis/nerd-fonts)
## Installation
[:arrow_up: TOC](#table-of-contents)
Installation is very easy and straight forward with many options to choose from.
As of now almost all installation methods require downloading resources from the Github Release page of the project, so to be a bit more secure consider **Checking the Signature** of `logo-ls_SHA512sums.txt` text file and then use this file to check weather the resource have been tampered. This complete process is explained in more detail in [Check the downloaded Resource](#check-the-downloaded-resource) section below. (This is a recommended step and not at all required)
### Debian (.deb package)
If you are on Debian or any other Debian based distribution then installation is simple.
#### Step 1
Download the `.deb` package from [Github Release Page](https://github.com/Yash-Handa/logo-ls/releases). Available OS_Architectures include: `i386`, `amd64`, `arm64` and `armV6`. Check your downloaded resource(s) if you like.
#### Step 2
Use the `dpkg -i path/to/downloaded/resource/` to install the binary and the manpage
### Red Hat (.rpm package)
If you are on Red Hat or any other Red Hat based distribution (like fedora) then installation is simple.
#### Step 1
Download the `.rpm` package from [Github Release Page](https://github.com/Yash-Handa/logo-ls/releases). Available OS_Architectures include: `i386`, `amd64`, `arm64` and `armV6`. Check your downloaded resource(s) if you like.
#### Step 2
Use the `rpm -i path/to/downloaded/resource/` to install the binary and the manpage
### MacOS (Darwin)
To install `logo-ls` on darwin you have to download the binary. Support for Homebrew will come soon
#### Step 1
Download `logo-ls_Darwin_x86_64.tar.gz` from [Github Release Page](https://github.com/Yash-Handa/logo-ls/releases).
#### Step 2
Extract a gzipped archive in the current directory.
```cmd
$ tar -xzf logo-ls_Darwin_x86_64.tar.gz
```
This will produce `logo-ls_Darwin_x86_64` directory in the current directory with the following files: `HELP.md`, `LICENSE`, `logo-ls` and `logo-ls.1.gz`
#### Step 3
Install the binary `logo-ls` by placing it in `/usr/local/bin`
```cmd
$ cd logo-ls_Darwin_x86_64
$ sudo cp logo-ls /usr/local/bin
```
#### Step 4
If you want the man page of `logo-ls` place `logo-ls.1.gz` in `/usr/share/man/man1/`
```cmd
$ sudo cp logo-ls.1.gz /usr/share/man/man1/
```
### Linux
To install `logo-ls` on any other Linux Distribution you have to download the binary.
#### Step 1
Download the `.tar.gz` archive from [Github Release Page](https://github.com/Yash-Handa/logo-ls/releases). Available OS_Arch include: `i386`, `x86_64` (`amd64`), `arm64` and `armV6`. Check your downloaded resource(s) if you like.
#### Step 2
Extract a gzipped archive in the current directory.
```cmd
$ tar -xzf logo-ls_Linux_[ARCH].tar.gz
```
This will produce `logo-ls_Linux_[ARCH]` directory in the current directory with the following files: `HELP.md`, `LICENSE`, `logo-ls` and `logo-ls.1.gz`
#### Step 3
Install the binary `logo-ls` by placing it in `/usr/local/bin`
```cmd
$ cd logo-ls_Linux_[ARCH]
$ sudo cp logo-ls /usr/local/bin
```
#### Step 4
If you want the man page of `logo-ls` place `logo-ls.1.gz` in `/usr/share/man/man1/`
```cmd
$ sudo cp logo-ls.1.gz /usr/share/man/man1/
```
### Check the downloaded Resource
receive public key of the signing party
After downloading the Resource(s) from the [Github Release Page](https://github.com/Yash-Handa/logo-ls/releases) follow the bellow steps to check its authenticity.
#### Step 1
Download `logo-ls_SHA512sums.txt.sig` and `logo-ls_SHA512sums.txt` from [Github Release Page](https://github.com/Yash-Handa/logo-ls/releases) and place them in the same directory as of the downloaded resource(s)
#### Step 2
Receive the public key of the signing party from `keyserver.ubuntu.com` server. This will add the developer's public key to your `keyring`.
```cmd
$ gpg2 --keyid-format long --keyserver keyserver.ubuntu.com --recv-keys 0x28182066bcacccb2
@@ -114,6 +338,8 @@ gpg: Total number processed: 1
gpg: unchanged: 1
```
#### Step 3
check the signature on logo-ls_SHA512sums.txt
```cmd
@@ -126,7 +352,9 @@ gpg: Good signature from "Yash Handa (logo-ls) <yashhanda7@yahoo.com>" [ultimate
A **Good** signature means that the checked file was definitely signed by the owner of the keyfile stated (if they didnt match, the signature would be reported as **BAD**)
Now use `logo-ls_SHA512sums.txt` file to verify the authenticity of the resource downloaded
#### Step 4
Use `logo-ls_SHA512sums.txt` file to verify the authenticity of the downloaded resource(s)
```cmd
$ sha512sum -c logo-ls_SHA512sums.txt 2>&1 | grep OK
@@ -138,60 +366,32 @@ logo-ls_Linux_i386.tar.gz: OK
logo-ls_Linux_armv6.tar.gz: OK
```
Note: The downloaded resources to verify and `logo-ls_SHA512sums.txt` should be in the same directory
## Recommended configurations
[:arrow_up: TOC](#table-of-contents)
To add some short command (say, `ils` or `ls`) with some flag options by default, add this to your shell configuration file (`~/.bashrc`, `~/.zshrc`, etc.) :
```bash
alias ils='logo-ls'
alias ila='logo-ls -A'
alias ill='logo-ls -al'
# equivalents with Git Status on by Default
alias ilsg='logo-ls -D'
alias ilag='logo-ls -AD'
alias illg='logo-ls -alD'
```
## Updating
## Uninstallation
[:arrow_up: TOC](#table-of-contents)
## Example Commands
<div>
<span align="center">
<img alt="logo-ls" title="logo-ls" src="/.github/images/ls.png">
</span>
</div><br>
<div>
<span align="center">
<img alt="logo-ls -aD" title="logo-ls -aD" src="/.github/images/ls-aD.png">
</span>
</div><br>
<div>
<span align="center">
<img alt="logo-ls -alhD" title="logo-ls -alhD" src="/.github/images/ls-alhD.png">
</span>
</div><br>
<div>
<span align="center">
<img alt="logo-ls -1Dhs" title="logo-ls -1Dhs" src="/.github/images/ls-1Dhs.png">
</span>
</div><br>
<div>
<span align="center">
<img alt="logo-ls -RD" title="logo-ls -RD" src="/.github/images/ls-RD.png">
</span>
</div><br>
<div>
<span align="center">
<img alt="logo-ls -a" title="logo-ls -a" src="/.github/images/ls-a.png">
</span>
</div><br>
<div>
<span align="center">
<img alt="logo-ls -oahd -T Kitchen" title="logo-ls -oahd -T Kitchen" src="/.github/images/ls-oahD.png">
</span>
</div><br>
As of now Updating is exactly similar as installation for [Debian (.deb package)](#debian-deb-package), [Red Hat (.rpm package)](#red-hat-rpm-package), [MacOS (Darwin)](#macos-darwin) and [Linux](#linux)
## Icon Set
[:arrow_up: TOC](#table-of-contents)
<div>
<span align="center">
<img alt="icons" title="Icon Set" src="/.github/images/icons.png">
@@ -200,4 +400,16 @@ Note: The downloaded resources to verify and `logo-ls_SHA512sums.txt` should be
## Contributing
[:arrow_up: TOC](#table-of-contents)
The project is always open to contributions. Especially for:
- More Icons
- Better ways to distribute software
- Translations to other Languages (linguistic)
## License
[:arrow_up: TOC](#table-of-contents)
The project is licensed under **MIT**. The Licence is available [here](/LICENSE).
+1
View File
@@ -1,3 +1,4 @@
// ctw is a custom tab writter package build to correctly display icons and colors for color-ls
package ctw
import (
+6
View File
@@ -437,6 +437,12 @@ var Icon_Ext = map[string]*iInfo{
"nupkg": iSet["nuget"],
"command": iSet["command"],
"dsc": iSet["denizenscript"],
"deb": iSet["debian"],
"rpm": iSet["redhat"],
"snap": iSet["ubuntu"],
"ebuild": iSet["gentoo"],
"pkg": iSet["applescript"],
"openbsd": iSet["freebsd"],
// "ls": iSet["livescript"],
// "re": iSet["reason"],
// "rei": iSet["reason"],
+14
View File
@@ -163,6 +163,20 @@ var iSet = map[string]*iInfo{
"stryker": {"\uf05b", [3]uint8{239, 83, 80}}, // stryker
"modernizr": {"\ue720", [3]uint8{234, 72, 99}}, // modernizr
"roadmap": {"\ufb6d", [3]uint8{48, 166, 154}}, // roadmap
"debian": {"\uf306", [3]uint8{211, 61, 76}}, // debian
"ubuntu": {"\uf31c", [3]uint8{214, 73, 53}}, // ubuntu
"arch": {"\uf303", [3]uint8{33, 142, 202}}, // arch
"redhat": {"\uf316", [3]uint8{231, 61, 58}}, // redhat
"gentoo": {"\uf30d", [3]uint8{148, 141, 211}}, // gentoo
"linux": {"\ue712", [3]uint8{238, 207, 55}}, // linux
"raspberry-pi": {"\uf315", [3]uint8{208, 60, 76}}, // raspberry-pi
"manjaro": {"\uf312", [3]uint8{73, 185, 90}}, // manjaro
"opensuse": {"\uf314", [3]uint8{111, 180, 36}}, // opensuse
"fedora": {"\uf30a", [3]uint8{52, 103, 172}}, // fedora
"freebsd": {"\uf30c", [3]uint8{175, 44, 42}}, // freebsd
"centOS": {"\uf304", [3]uint8{157, 83, 135}}, // centOS
"alpine": {"\uf300", [3]uint8{14, 87, 123}}, // alpine
"mint": {"\uf30f", [3]uint8{125, 190, 58}}, // mint
"pug": {"\ue60e", [3]uint8{239, 204, 163}}, // pug (Not supported by nerdFont)
"blink": {"\uf72a", [3]uint8{249, 169, 60}}, // blink (The Foundry Nuke) (Not supported by nerdFont)
"postcss": {"\uf81b", [3]uint8{244, 68, 62}}, // postcss (Not supported by nerdFont)