Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skippyr/dl

A simple directory listing utility for Windows and Linux.
https://github.com/skippyr/dl

c command-line developer-tools file-system files linux productivity terminal windows

Last synced: 3 days ago
JSON representation

A simple directory listing utility for Windows and Linux.

Awesome Lists containing this project

README

        




≥v≥v dl ≥v≥v


Directory Lister




 

 

 

## ❡ About

An enhanced directory listing utility available for Windows, Linux and MacOS. It includes new features such as a new layout, colors and icons, improving usability and readability.





Caption: dl being used to list a directory on MacOS and Windows. Terminal theme is Flamerial. Shell theme is River Dreams. Font is Hack (patched by the Nerd Fonts project).

> [!NOTE]
> The font and colors used in the software may be affected by your terminal settings. Images for illustration purpose only.

## ❡ Install

### Dependencies

The following dependencies must be installed before it:

#### Dependencies For Windows

- **[Visual Studio 2022](https://visualstudio.microsoft.com) with the "Desktop development with C++" workload:** it provides all the tools required to build this sofware.
- **[Git](https://git-scm.com):** it will be used to clone this repository.
- **A font patched by the [Nerd Fonts project](https://www.nerdfonts.com/font-downloads):** it provides the pretty symbols used by the software.

#### Dependencies For Linux

- **GCC, CMake:** they will be used to build this sofware.
- **Git**: it will be used to clone this repository.
- **A font patched by the [Nerd Fonts project](https://www.nerdfonts.com/font-downloads):** it provides the pretty symbols used by the software.

> [!TIP]
> Use your distro package manager to install these packages.

#### Dependencies For MacOS

- **Apple Command Line Tools**, **CMake**: they will be used to build this sofware.
- **Git**: it will be used to clone this repository.
- **A font patched by the [Nerd Fonts project](https://www.nerdfonts.com/font-downloads):** it provides the pretty symbols used by the software.

> [!TIP]
> Use `xcode-select --install` to install the Apple command line tools. For the rest, use [HomeBrew](https://brew.sh/).

### Procedures

On Windows, using the `Developer PowerShell for VS 2022` profile or, on any other operating systems, using any terminal, follow these instructions:

- Clone this repository using `git`:

```zsh
git clone --depth 1 --recurse-submodules https://github.com/skippyr/dl;
```

- Access its directory:

```zsh
cd dl;
```

- Use `cmake` to build and install it:

```zsh
cmake -B build/cmake;
cmake --build build/cmake --config release;
cmake --install build/cmake;
```

- Add the directory `build/bin` that was generated during the build to your system `PATH` environment variable.
- Reload your shell session.
- `dl` should now be installed and available as a command.

## ❡ Documentation

After installed, you can read its help page for usage instructions:

```zsh
dl --help
```

## ❡ Help

If you need help related to this project, open a new issue in its [issues pages](https://github.com/skippyr/dl/issues) or send me an [e-mail](mailto:[email protected]) describing what is going on.

## ❡ Contributing

This project is open to review and possibly accept contributions, specially fixes and suggestions. If you are interested, send your contribution to its [pull requests page](https://github.com/skippyr/dl/pulls) or to my [e-mail](mailto:[email protected]).

In order to keep it open-source, by contributing to this project, you must agree to license your work under the same license that the project uses. For other intentions, prefer to create a fork.

## ❡ License

This is free software licensed under the BSD-3-Clause License that comes WITH NO WARRANTY. Refer to the `LICENSE` file that comes in its source code for license and copyright details.


Birth: March 30th 2024.


≥v≥v Here Be Dragons! ≥v≥
Made with love by skippyr <3