diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9950cc1 --- /dev/null +++ b/README.md @@ -0,0 +1,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 +``` + |