Skip to content

Commit 2afd02d

Browse files
authored
Add description of problems and how we solve them
1 parent 9bda708 commit 2afd02d

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,41 @@
33

44
# bashables
55

6-
> A library of bash code, scripts and examples for use when writing your own utilities.
6+
> A framework and library of bash code, scripts and examples for use when writing your own utilities.
7+
8+
## What is bashables?
9+
10+
It is a framework and library meant to help you write and distribute your own portable utilities.
11+
12+
### The problem we're solving
13+
14+
A lot of projects have tasks or setup that needs to be performed so that the developers can be productive.
15+
16+
Some examples:
17+
18+
- Installing compilers.
19+
- Verifying tools are installed and are a compatible version.
20+
- Checking on the status of software running in the cloud.
21+
- Authenticating or switching accounts.
22+
- Running analysis tools.
23+
- Formatting code according to project standards.
24+
25+
These utilities must be able to work on a developer's laptop which may be Linux, macOS, BSD, or even WSL (Windows Subsystem for Linux) regardless of what tools they have installed or have not installed.
26+
27+
Furthermore, the utilities must be kept up-to-date irrespective of changes in the project's code base.
28+
29+
The utilities almost always have little documentation and no testing.
30+
31+
### How we're solving the problem
32+
33+
We are providing a library of common functions. These are functions that I have written over and over again.
34+
35+
We provide tools to bundle and update the utility into a single package, if possible. These bundles will be easy to install and update.
36+
37+
We will provide tools to create `bash` documentation so that others can work on the generated utilities.
38+
39+
Finally, we are providing some help with writing tests for these utilities.
40+
41+
## Contributuing
42+
43+
Please check out the [CONTRIBUTING guide](CONTRIBUTING.md).

0 commit comments

Comments
 (0)