Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# ES-Progress Bash Library
# Introduction

Hi! :cowboy_hat_face:

Here you can find the documentation for [_ES-Progress Bash Library_](https://github.com/es-progress/shell){target=\_blank}.

There are some standalone shell scripts, called "binaries" (`bin/`) here :wink: and various shell functions (`lib/`).
This library consist of standalone shell scripts, called "binaries" (`bin/`) here :wink: and various shell functions (`lib/`).
Certain functions are useful for interactive use on the command-line, while others makes more sense sourced in scripts.
It was written with Bash in mind therefore portability was not a requirement.

First, check the [Installation instructions](install.md).
Though most of the "binaries" are intended for standalone use which you can simply download and run,
some of them use functions from the library ("lib") and bootstrapping may not be trivial.

Then you can find the reference documentation for each script, function.
Then you can find the reference documentation for each script and function.

!!! note

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## mkdocs config ##
###################
---
site_name: Bash Library of ES-Progress
site_name: ES-Progress Bash Library
site_url: https://shell.es-progress.hu
site_author: Sandor Semsey
copyright: |
Expand Down