Skip to content

Commit

Permalink
[INSTALL] changed install to use NPX and updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kyle-west committed Jan 29, 2019
1 parent 17ce529 commit cfc2589
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 16 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,30 @@ A list of available tools and their usages can be found on the [Documentation Pa

Though most of the code is not written in JavaScript, I use the Node Package
Manager to handle installing and script running, since it is familiar to many.
To install the toolset suite run:
To install the toolset run:

```sh
npx -q https://github.com/kyle-west/bashful.git
```

To install without NPM run:

```sh
# clone the suite installation package:
git clone https://github.com/kyle-west/bashful.git
cd bashful/

# run the installation
npm install
sh ./install.sh
```

When this script completes, **you will be prompted to restart your terminal**. This
When either script completes, **you must restart your terminal**. This
is because the installation edits your `$path` environment variable to make the
tools accessible in all contexts.

Go ahead and delete the cloned repo. The programs will still work, and you
can later install/uninstall things with the `bashful` CLI.
### Installing / Uninstalling Tools

`bashful` CLI has it's own installation management of tools, including gists. See the [Docs](https://kyle-west.github.io/bashful/bashful.html) for more info.

### Uninstalling the entire Suite

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# BASHful Suite Tools

<link rel="shortcut icon" type="image/png" href="/bashful/docs/favicon.png"/>
<link rel="shortcut icon" type="image/png" href="favicon.png"/>

## [`bashful`](./bashful.md)

Expand Down
5 changes: 2 additions & 3 deletions install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ echo;

# remove old suites
echo Removing old suites
bash uninstall.sh
bash uninstall.sh uninstalled-as-prep-for-install

__bash_suite_program_dir=~/.bashful
__bash_suite_filesys=~/.bashful.filesys
Expand All @@ -15,13 +15,12 @@ import_path_line='source ~/.bashful.filesys/bashful.rc'
echo $import_path_line >> ~/.bash_profile;
echo $import_path_line >> ~/.zshrc;
echo Done
echo $PATH
echo;

# install tools
echo Copying over programs:
cp ./bin/* "$__bash_suite_program_dir/"
ls $__bash_suite_program_dir
echo -e "\t" `ls $__bash_suite_program_dir`
echo Done
echo;

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "bashful",
"version": "2.1.0",
"version": "2.2.0",
"description": "Install my custom suite of terminal tools for Bash in OSX",
"main": "install.sh",
"scripts": {
Expand Down
14 changes: 8 additions & 6 deletions uninstall.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@ echo -e "$edited_profile" > ~/.zshrc;
echo Done
echo;

# prompt the user to restart terminal
echo;
echo BASHful Suite by kyle-west
echo Uninstall Complete
echo !!! Please restart your terminal to allow the changes to take effect !!!
echo;
if [ "$1" != "uninstalled-as-prep-for-install" ]; then
# prompt the user to restart terminal
echo;
echo BASHful Suite by kyle-west
echo Uninstall Complete
echo !!! Please restart your terminal to allow the changes to take effect !!!
echo;
fi

0 comments on commit cfc2589

Please sign in to comment.