Skip to content

Commit

Permalink
docs: add alias information
Browse files Browse the repository at this point in the history
  • Loading branch information
FranckG28 committed Dec 30, 2023
1 parent 1cc9a8f commit 76796ce
Showing 1 changed file with 39 additions and 17 deletions.
56 changes: 39 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down

0 comments on commit 76796ce

Please sign in to comment.