johnnydecimal

This repository contains several tools for working with Johnny Decimal systems.

Installation

Step 1: Install Johnnydecimal

From source

1. Install rust. Go to the rust installation page and follow the instructions.

2. Clone the repository.

git clone https://github.com/Tallented-code-bot/johnnydecimal
cd johnnydecimal

3. Compile the project.

cargo build --release

4. Move the binary to somewhere on your path. For example, you might move it to ~/.local/bin/ if you are on Linux. Important: the binary is called jd, not johnnydecimal.

mv ./target/release/jd ~/.local/bin/

From binary

1. Download the zip or tar file for your OS from the release page.

2. If you are on windows, extract the zip file. If you are on mac/linux, you can extract the tar.gz file like this.

tar -xvf <tar.gz file>

3. Move the jd or jd.exe executable to somewhere on your path. On linux a good place could be ~/.local/bin/.

Step 2: Add Johnnydecimal to your shell

This enables you to easily cd to any johnnydecimal number. If you do not want this, you can skip it.

Fish

Add this to your configuration, usually found at ~/.config/fish/config.fish.

jd init fish | source

Bash

Add this to your configuration, usually found at ~/.bashrc.

eval "$(jd init bash)"

Zsh

Add this to your configuration, usually found at ~/.zshrc.

eval "$(jd init zsh)"

Getting started

The first thing you need to do is index your Johnny Decimal system.

1. Go to the folder above your Johnny Decimal root folder. For example, if your root folder is ~/jd, you would go to ~.

2. Run jd index <ROOT_FOLDER>. For this example, you would run jd index jd/. This will look at all your files and write the index to <ROOT_FOLDER>/.JdIndex.

3. As long as you are inside your root folder, you can use jd. You could show all your JD numbers with jd show, you could add a new one with jd add <CATEGORY>, or you could go to a specific one with j <JD_NUMBER>(assuming that you added the config to your shell!).

Contributing and License

This project is under the GNU GPL-3 license. (You can view the license here.)

Feel free to contribute to this project, either by submitting a pull request or by adding an issue.