Skip to content

Commit

Permalink
update: README.md: links & moved installation up
Browse files Browse the repository at this point in the history
  • Loading branch information
araekiel committed Sep 17, 2022
1 parent a950481 commit 79e6f90
Showing 1 changed file with 16 additions and 15 deletions.
31 changes: 16 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@
<a href="https://crates.io/crates/jt"><img alt="Cargo" src="https://img.shields.io/badge/cargo-jt-blue"></a>

<p>
<a href="#highlights">Highlights</a> •
<a href="#notes">Notes</a> •
<a href="#installation">Installation</a> •
<a href="#notes">Notes</a> •
<a href="#usage">Usage</a> •
<a href="#changelog">Changelog</a> •
<a href="#build-from-source">Build from Source</a> •
<a href="#dependencies">Dependencies</a> •
<a href="#authors">Authors</a> •
<a href="#license">License</a>
</p>
Expand All @@ -28,6 +29,18 @@ Commands that encompass all basic needs are included. Each command has an alias

Jot is under active development. While it contains all basic functions that should serve most needs, there's a laundry list of features that are yet to and will be added overtime.

## Installation

#### ***Install with cargo:***

```bash
$ cargo install jt
```

#### ***Use executable*** (only for windows)

Download [Jot v0.1.1](https://github.com/araekiel/jot/releases/download/v0.1.1/jt.exe) (.exe) and add it to your path.

## Notes

- App data is stored in config and data files in locations generated by the [***directories***](https://crates.io/crates/directories) crate. Individual Vault data is stored in '***.jot***' folder inside each vault. It is advised that these files not be tampered with, since atm there's no way to automatically fix them.
Expand Down Expand Up @@ -172,26 +185,14 @@ $ jt config editor code.cmd
- As advised by [***u/epage***](https://www.reddit.com/user/epage/) ([github/epage](https://github.com/epage)) on my r/rust [***post***](https://www.reddit.com/r/rust/comments/xebk9j/i_am_working_on_a_cli_alternative_for_obsidian/), commands are now represented by their full word, and the two letter abbreviations (previously serving as commands themselves) are now aliases for these commands.
- Updated docs.

## Installation

#### ***Install with cargo:***

```bash
$ cargo install jt
```

#### ***Use executable*** (only for windows)

Download [Jot v0.1.1](https://github.com/araekiel/jot/releases/download/v0.1.1/jt.exe) (.exe) and add it to your path.

## Build from Source

### Prerequisites

- Git is need to clone the repository on your machine.
- Cargo is needed to compile the program.

### Installation
### Build

Clone the repo and cd into the directory:

Expand Down

0 comments on commit 79e6f90

Please sign in to comment.