Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
VladBrok committed Sep 5, 2022
1 parent 0cb7b73 commit 2d492be
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
67 changes: 67 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<div align="center">

# Navigatio

[![video demonstration](images/preview.png)](https://screenrec.com/share/RJh5qOrtn0)

Fast navigation between directories

</div>

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Introduction

If you use a terminal and you need to move between directories frequently, then this application is for you! Define aliases and use them to quickly navigate between directories. If you accidentally used the wrong command, don't worry. The cancellation command `nav -u` will take care of this!

## Features

- Create aliases for directories and navigate to them quickly
- Cancel previous actions

## Installation

1. Download and install [git](https://git-scm.com/download/win) (you'll need a git bash in order to use the app)

2. Download and unpack the latest [release](https://github.com/VladBrok/navigatio/releases) for your specific platform

_By now, only Windows is supported_

3. Run the setup

```bash
source release-setup.sh
```

Now you can run `nav -h` for a list of all available commands

## Usage

Navigation:

- `nav <alias>` Navigate to this alias

Managing aliases:

- `nav --help|-h` A list of all commands
- `nav --add|-a <alias> <relative_or_absolute_path>` Add an alias
- `nav --delete|-d <alias>` Remove an alias
- `nav --show|-s` List all of your aliases

Cancelling actions:

- `nav --undo|-u` Undo the previous action

Changing settings:

- `nav --change-settings|-cs` Adjust a limit of the command history and set your favorite editor

## License

Navigatio is available under the [MIT license](https://opensource.org/licenses/MIT)
Binary file added images/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2d492be

Please sign in to comment.