Add LICENSE and README.md, and update run scripts comments
This commit is contained in:
parent
7276f25128
commit
56e4583314
|
@ -0,0 +1,19 @@
|
||||||
|
Copyright (c) 2020 mitchell
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
|
@ -0,0 +1,11 @@
|
||||||
|
# run(.fish)
|
||||||
|
|
||||||
|
This repo contains my run(.fish) script. It serves as a central place to store and document commands
|
||||||
|
related to a project. It was written with the KISS principle at the forefront of my mind. New
|
||||||
|
versions will only ever be simple enough to understand almost immediately.
|
||||||
|
|
||||||
|
In this repo is a hello world example. You can just copy this script to your repo and replace it's
|
||||||
|
command functions with your own. You're encouraged to modify it to your needs, but I urge you to
|
||||||
|
keep the KISS principle in mind as well. Shell scripts have a way of getting away from you (who
|
||||||
|
knew?).
|
||||||
|
|
9
run
9
run
|
@ -1,5 +1,6 @@
|
||||||
#!/usr/bin/env fish
|
#!/usr/bin/env fish
|
||||||
# This 'run script' serves as a central place to store frequently run commands for this project.
|
# This run(.fish) script serves as a central place to store frequently run commands for this project.
|
||||||
|
# Source: https://github.com/mitchell/run.fish
|
||||||
|
|
||||||
### Config ###
|
### Config ###
|
||||||
# Top-level configurations, like function prefixes and argument delimeters
|
# Top-level configurations, like function prefixes and argument delimeters
|
||||||
|
@ -9,7 +10,7 @@ set -g run_arg_delimeter ':'
|
||||||
|
|
||||||
### Commands ###
|
### Commands ###
|
||||||
# Add, edit, and remove commands freely below.
|
# Add, edit, and remove commands freely below.
|
||||||
# To add a command simply create a function with this naming scheme: run_{command}.
|
# To add a command simply create a function with this naming scheme: {run_func_prefix}_{name}.
|
||||||
#
|
#
|
||||||
function run_hello
|
function run_hello
|
||||||
echo 'hello, world!'
|
echo 'hello, world!'
|
||||||
|
@ -32,10 +33,10 @@ function run_lang -a command
|
||||||
end
|
end
|
||||||
|
|
||||||
### Command Execution ###
|
### Command Execution ###
|
||||||
# Do not edit, unless you want to alter how to script runs commands.
|
# Do not edit, unless you want to alter how to script executes commands.
|
||||||
#
|
#
|
||||||
# This script can execute 1 or more commands like makefile. It can also receive 1 argument per
|
# This script can execute 1 or more commands like makefile. It can also receive 1 argument per
|
||||||
# command in the following format: {command}.{argument}.
|
# command in the following format: {name}{run_arg_delimeter}{argument}.
|
||||||
#
|
#
|
||||||
# Examples:
|
# Examples:
|
||||||
# ./run hello
|
# ./run hello
|
||||||
|
|
Loading…
Reference in New Issue