summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorJTaylor <jtaylor@classicalconversations.com>2020-12-02 16:37:34 -0500
committerJTaylor <jtaylor@classicalconversations.com>2020-12-02 16:37:34 -0500
commit405be2d02b72481b7ad40d35e15a6db54cba354d (patch)
tree856287001f9f6352b7962ee36640fd46a31a931d /README
parent99c0cba6818d3e1855ee783318b59441ca052c64 (diff)
Rename README
This will change the syntax highliting on Github
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 0 insertions, 28 deletions
diff --git a/README b/README
deleted file mode 100644
index 9950cc1..0000000
--- a/README
+++ /dev/null
@@ -1,28 +0,0 @@
-# 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
-```
-