Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jvictorferreira3301 authored Jul 24, 2024
1 parent ed612b0 commit b5ec136
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

- [C MIMO - Implementation of MIMO Digital Communication System](#c-mimo---implementation-of-mimo-digital-communication-system)
- [Project Description](#project-description)
- [Requisites](#requisites-💻)
- [How to Use](#how-to-use-🚀)
- [Requisites](#requisites)
- [How to Use](#how-to-use)
- [Custom Mode](#custom-mode)
- [Pre-setting Mode](#pre-setting-mode)
- [Results Analysis](#results-analysis)
Expand All @@ -23,10 +23,9 @@ This project was developed for the Engineering Project II course taught in the s

Since its initial development, this project has been enhanced with new features and evaluation metrics, further expanding its capabilities and usefulness to now serve as an educational tool for others to learn just as we did during the project's development. The enhancements have been designed to provide a practical understanding of high-capacity wireless communications, particularly relevant with the advent of fifth-generation (5G) mobile networks. The project, developed in alignment with the [Conceive, Design, Implement, and Operate (CDIO)](http://www.cdio.org/) initiative, aims to help students grasp the fundamentals of modern communication systems and signal processing. By offering comprehensive documentation and free access, it aims to contribute to the educational resources available to the telecommunications community.

A detailed description of these enhancements and the overall project can be found in our [website's documentation](https://lasseufpa.github.io/C_MIMO/) and in the paper titled [*Development of a MIMO System for Education in
Digital Communications: A CDIO Approach*]().
A detailed description of these enhancements and the overall project can be found in our [website's documentation](https://lasseufpa.github.io/C_MIMO/).

## Requisites 💻
## Requisites

- GSL Library (`gsl/gsl_linalg.h`): The GNU Scientific Library (GSL) is a numerical library for C and C++. In this case, the linear algebra part is being used.

Expand All @@ -38,7 +37,7 @@ To install the dependencies above run `install_dependencies.sh` with the followi
sh install_dependencies.sh
```

## How to Use 🚀
## How to Use

To compile the project, run the following command in the terminal:

Expand All @@ -60,7 +59,7 @@ make clean

The system offers two modes of operation, upon execution, the user is prompted to choose between these two modes. The choice is made through a simple console interface where the user inputs either 1 for the pre-setting mode or 2 for the custom mode.

### Pre-setting Mode (Default Mode)
### Pre-setting Mode
In Pre-setting Mode, the system operates with predefined parameters. This mode is designed for users who prefer to run the system with standard configurations without customization.

- **Receive Antennas ($N_r$):** Varies in the set $\{2^1, 2^2, \ldots, 2^7\}$
Expand Down

0 comments on commit b5ec136

Please sign in to comment.