Skip to content

Commit

Permalink
Added basic structure to README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
Yash-Handa committed Sep 9, 2020
1 parent 2462e8d commit 8309343
Showing 1 changed file with 97 additions and 3 deletions.
100 changes: 97 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,101 @@
![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/Yash-Handa/logo-ls?sort=semver&style=flat-square)
![PRs](https://img.shields.io/badge/PRs-welcome-56cc14?style=flat-square)
[![HitCount](http://hits.dwyl.com/{Yash-Handa}/{logo-ls}.svg)](http://hits.dwyl.com/{Yash-Handa}/{logo-ls})

![deb](https://img.shields.io/badge/-Deb%20Package-A81D33?style=flat-square&logo=Debian&link=https://github.com/Yash-Handa/logo-ls/releases/)
![rpm](https://img.shields.io/badge/-RPM%20Package-EE0000?style=flat-square&logo=Red-Hat&link=https://github.com/Yash-Handa/logo-ls/releases/)
![linux](https://img.shields.io/badge/-Linux%20Binary-FCC624?style=flat-square&logo=Linux&logoColor=000000&link=https://github.com/Yash-Handa/logo-ls/releases/)
![apple](https://img.shields.io/badge/-Darwin%20Binary-999999?style=flat-square&logo=Apple&logoColor=ffffff&link=https://github.com/Yash-Handa/logo-ls/releases/)

modern ls command with vscode like file logos. Written in Golang
modern ls command with beautiful Icons and Git Integrations . Written in Golang

Command and Arguments supported are listed in [HELP.md](/HELP.md)

## Check the downloaded Resource
## Table of contents

- [Features](#features)
- [Usage](#usage)
- [Flags](#flags)
- `-1`
- `-a` (or) `--all`
- `-A` (or) `--almost-all`
- `-D` (or) `--git-status`
- `-l`, `-o`, `-g`, `-G`
- `-R` (or) `--recursive`
- `-?` (or) `--help`
- Sorting:
- `-t`, `-S`, `-X`, `-U`, `-v` and `-r` (`--reverse`)
- `-T` (or) `--time-style=value`
- `-i` (or) `--disable-icon`
- `-c` (or) `--disable-color`
- [Combination of flags](#combination-of-flags)
- [Multiple Files and Directories](#multiple-files-and-directories)
- [Installation](#installation)
- [Recommended configurations](#recommended-configurations)
- [Updating](#updating)
- [Uninstallation](#uninstallation)
- [Icon Set](#icon-set)
- [Contributing](#contributing)
- [License](#license)

## Features

This project is build to add esthetics to ls(coreutiles) command

- Over 250+ icons
- Supporting 600+ files, extensions and directories
- 16 Million, true colors supported
- Git Status Integration
- 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

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`

### Flags

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
- With `-a` (or) `--all` : Does not ignore entries starting with '.'
- With `-A` (or) `--almost-all` : Does not ignore entries starting with '.', except `./` and `../`
- 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.
- 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
- With `-R` (or) `--recursive`: list subdirectories recursively
- With `-?` (or) `--help`: print the help message
- similar message can be found at [HELP.md](/HELP.md).
- **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
- With `-X`: sort alphabetically by entry extension
- 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
- 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).
- With `-i` (or) `--disable-icon`: don't print icons of the files
- 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`

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.

### Multiple Files and Directories

You can provide multiple files and directories as command argument [default to PWD] and all will be displayed accordingly.

### Check the downloaded Resource

receive public key of the signing party

Expand Down Expand Up @@ -56,6 +140,12 @@ 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

## Updating

## Uninstallation

## Example Commands

<div>
Expand Down Expand Up @@ -107,3 +197,7 @@ Note: The downloaded resources to verify and `logo-ls_SHA512sums.txt` should be
<img alt="icons" title="Icon Set" src="/.github/images/icons.png">
</span>
</div><br>

## Contributing

## License

0 comments on commit 8309343

Please sign in to comment.