extern/bat-extras
1
0
Fork 0
mirror of https://github.com/eth-p/bat-extras.git synced 2024-12-12 09:10:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added license.

Browse Source
This commit is contained in:
Ethan P 2019-06-19 14:41:20 -07:00
parent 248d7077f4
commit db50cbe753
No known key found for this signature in database
GPG Key ID: 1F8DF8091CD46FBC
2 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
LICENSE.md Normal file
View File

@ -0,0 +1,8 @@
Copyright 2019 eth-p
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.

17
README.md
View File

@ -2,22 +2,24 @@
Bash scripts that integrate [bat](https://github.com/sharkdp/bat) with various command line tools. Bash scripts that integrate [bat](https://github.com/sharkdp/bat) with various command line tools.
 
## Scripts ## Scripts
- [`batgrep`](doc/batgrep.md) (ripgrep + bat) - [`batgrep`](doc/batgrep.md) (ripgrep + bat)
 
## Installation ## Installation
The scripts in this repository are designed to run as-is, provided that they aren't moved around. The scripts in this repository are designed to run as-is, provided that they aren't moved around.
This means that you're free to just symlink `src/[script].sh` to your local bin folder. This means that you're free to just symlink `src/[script].sh` to your local bin folder.
If you would rather have self-contained scripts that you can place any run anywhere, you can use the `build.sh` script to create (and optionally install) them. If you would rather have self-contained scripts that you can place and run anywhere, you can use the `build.sh` script to create (and optionally install) them.
**Build:**  
**Building:**
```bash ```bash
./build.sh [OPTIONS...] ./build.sh [OPTIONS...]
@ -25,7 +27,7 @@ If you would rather have self-contained scripts that you can place any run anywh
This will combine and preprocess each script under the `src` directory, and create corresponding self-contained scripts in the `bin` folder. Any library scripts that are sourced using `source "${LIB}/[NAME].sh"` will be embedded automatically. This will combine and preprocess each script under the `src` directory, and create corresponding self-contained scripts in the `bin` folder. Any library scripts that are sourced using `source "${LIB}/[NAME].sh"` will be embedded automatically.
 
**Minification:** **Minification:**
@ -37,13 +39,10 @@ There are three different options for minification:
| `--minify=lib` | Embedded library scripts will be minified. [default] | | `--minify=lib` | Embedded library scripts will be minified. [default] |
| `--minify=all` | Everything will be minified. | | `--minify=all` | Everything will be minified. |
This uses [bash_minifier](https://github.com/precious/bash_minifier) to perform minification, and requires Python 2 to be installed as either `python2` or `python`. This uses [bash_minifier](https://github.com/precious/bash_minifier) to perform minification, and requires Python 2 to be installed as either `python2` or `python`.
 
**Installation:** **Installation:**
You can also specify `--install` and `--prefix=PATH` to have the build script automatically install the scripts for all users on the system. You may need to run the build script as root. You can also specify `--install` and `--prefix=PATH` to have the build script automatically install the scripts for all users on the system. You may need to run the build script as root.