diff --git a/README.md b/README.md index 2b77092..32d2a3a 100644 --- a/README.md +++ b/README.md @@ -20,14 +20,16 @@ - [Command Sequencing](#command-sequencing) - [Batch Mode](#batch-mode) - [Background Execution](#background-execution) -- [πŸ“– Use the livl-bash man command](#-use-the-livl-bash-man-command) -- [πŸ“œ Doxygen documentation](#-doxygen-documentation) - - [πŸ“¦ Prerequisites of Doxygen](#-prerequisites-of-doxygen) - - [πŸš€ Generate the Doxygen documentation](#-generate-the-doxygen-documentation) -- [πŸ§ͺ GCOV test coverage](#-gcov-test-coverage) - - [πŸ“¦ Prerequisites of gcov](#-prerequisites-of-gcov) - - [πŸš€ Generate the coverage report](#-generate-the-coverage-report) -- [πŸ› οΈ Pipeline](#️-pipeline) + - [Alias](#alias) +- [Working with the documentation](#working-with-the-documentation) + - [πŸ“– Use the livl-bash man command](#-use-the-livl-bash-man-command) + - [πŸ“œ Doxygen documentation](#-doxygen-documentation) + - [πŸ“¦ Prerequisites of Doxygen](#-prerequisites-of-doxygen) + - [πŸš€ Generate the Doxygen documentation](#-generate-the-doxygen-documentation) + - [πŸ§ͺ GCOV test coverage](#-gcov-test-coverage) + - [πŸ“¦ Prerequisites of gcov](#-prerequisites-of-gcov) + - [πŸš€ Generate the coverage report](#-generate-the-coverage-report) +- [πŸ› οΈ Pipelines](#️-pipelines) - [1. C-Make Pipeline](#1-c-make-pipeline) - [2. Static Pipeline](#2-static-pipeline) - [🧍🏽Project team](#-project-team) @@ -99,7 +101,7 @@ livl-shell/ └── Makefile # Makefile ``` -## πŸ“ List of Insane livl-bash Commands +## πŸ“ List of Insane livl-bash features > πŸ’‘ The livl-shell is limited to run a maximum of 3 commands in a row. @@ -139,43 +141,63 @@ livl-shell/ - `sleep 3 & echo hey`: Executes a command in the background (the shell will not wait for the command to finish) and it will show you the job id of the background process (ex: `[1] 1234`). - `pwd`: Running this command will display the job id of the background process terminated (ex: `[1] done sleep 3`). -## πŸ“– Use the livl-bash `man` command +### Alias + +Livl-shell provide a basic alias support. Alias can be defined only by editing the `alias.txt` file. The syntax is the following: + +``` +alias_name="command" +``` + +For example, if you want to create an alias for the `ls -l` command, you can add the following line to the `alias.txt` file: + +``` +ll="ls -l" +``` + +Then, you can run the `ll` command to execute the `ls -l` command. + +> Note that you can't use alias inside alias, and your input need to be exactly the alias name. You can't add arguments to an alias when using the shell. + +## Working with the documentation + +### πŸ“– Use the livl-bash `man` command > To edit the man you can download a TROFF Syntax Highlighter for Visual Studio Code. - The `man livl-shell` manual is located in the [`livl-shell.1`](livl-shell.1) file - To view the manual, run : `man ./livl-shell.1` -## πŸ“œ Doxygen documentation +### πŸ“œ Doxygen documentation > ❓ Doxygen is a documentation generator, a tool for writing software reference documentation. -### πŸ“¦ Prerequisites of Doxygen +#### πŸ“¦ Prerequisites of Doxygen - Download doxygen : `sudo apt install doxygen` -### πŸš€ Generate the Doxygen documentation +#### πŸš€ Generate the Doxygen documentation - Run `make doc` to generate the documentation - To view the documentation, open the [`index.html`](/doc/html/index.html) file in the `doc/html/` folder. -## πŸ§ͺ GCOV test coverage +### πŸ§ͺ GCOV test coverage > ❓ GCOV is a test coverage program. It helps you determine how much of your source code is being tested by your test suite. It is a useful tool for finding untested code. -### πŸ“¦ Prerequisites of gcov +#### πŸ“¦ Prerequisites of gcov - Download gcov : `sudo apt install gcov` - Download lcov : `sudo apt install lcov` -### πŸš€ Generate the coverage report +#### πŸš€ Generate the coverage report - Run `make gcov` to generate the coverage report - To exit the coverage report, press `exit` two times (one for the shell and one for the coverage report) - To view the coverage report, open the [`index.html`](/gcov/report/index.html) file in the `gcov/report/` folder or run `gcovr -r .` - Run `make clean-gcov` to clean the `gcov` folder -## πŸ› οΈ Pipeline +## πŸ› οΈ Pipelines Our pipelines are configured to be triggered on each `push` and `pull request` event on the `master` branch. We have two main pipelines: