summaryrefslogtreecommitdiff
path: root/README.md
blob: 9950cc1eb4b7f2ece63e0f9572c3f73bd911df1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# JAPH - Jackson's Awesome Project Helper

## Purpose
Japh is a command line utility to help with manuevering your files
and building project specific commands.

## Installation
You will need to `source` the japh file from inside your
`$HOME/.bashrc` wherever you have it installed.

You also need to make sure that you have write access to the directory that
japh is stored. For now, it simply puts all the commands it makes into a file
called `cmds` in the same directory.

## What is a command?
These are functions that japh runs based on user input. I.E. changing
directories, running build commands, etc.

## Usage
- Add a new project
```
[bashprompt] $ japh add projectname
```
- Switch to a project
```
[bashprompt] $ japh projectname
```