bes-build/README.md
2017-04-30 05:19:21 +02:00

50 lines
1.0 KiB
Markdown

bes-build
=========
bes-build is a bash script to build bash program.
the building process simply consist to append shell script files from your `src/` project directory
into a single `dist/project` executable file
### Install
```
wget https://raw.githubusercontent.com/meta-tech/bes-build/latest/dist/bes-build
bash ./bes-build -i
```
### Usage
```shell
# change directory to your project
cd /home/repo/meta-tech/bes
bes-build
# you can now execute program with :
./dist/bes
# to display help execute :
bes-build -h
```
### Requirements
using bes-build script require you to conform to these following rules :
* respect this directory structure :
```pre
project/
|
|--- src/
|
|--- file1.sh
|--- file2.sh
|--- file3.sh
```
* each `src/` shell file require a `shebang` on first line (**#!/bin/bash**)
* src/main.sh file is append to the end of the build file
* we strongly recommand you to use function and prefix function name
```shell
bes.install(){
...
}
```