From 19a1539f85f66f56b56100cf0e36ac7d191b4850 Mon Sep 17 00:00:00 2001 From: Shawn Wells Date: Tue, 17 Oct 2023 22:05:19 -0400 Subject: [PATCH] Update README.md with copy edits, fixes typos, updates make command - Fixes typo of ``cd srsGUI``.... needs to be capitalized to match repo name - Updates make command to use -j`nproc`, which ensures all cores are used on ``make`` and speeds things up a bit - Adds ``bash`` style to shell prompts for readability --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index dfc47811..f57661d1 100644 --- a/README.md +++ b/README.md @@ -17,22 +17,31 @@ Download & Install Instructions Requirements: Boost (thread, unit_test_framework, system), QT5 and Qwt6 To install Boost, QT5 and Qwt6, use your distribution packet management system. -For instance in ubuntu you can run: ```sudo apt-get install libboost-system-dev libboost-test-dev libboost-thread-dev libqwt-qt5-dev qtbase5-dev``` +For instance in ubuntu you can run: +```bash +sudo apt-get install libboost-system-dev libboost-test-dev libboost-thread-dev libqwt-qt5-dev qtbase5-dev +``` Finally, to download and build srsGUI, just run: -``` +```bash git clone https://github.com/srsLTE/srsGUI.git -cd srsgui +cd srsGUI mkdir build cd build cmake ../ -make +make -j`nproc` ``` -The library can also be installed using the command ```sudo make install```. +The library can also be installed using the command: +```bash +sudo make install -j`nproc` +``` Running srsGUI Examples ======================== -The library includes a number of tests which illustrate use of both C and C++ interfaces. These can be found in the test folder. After building the library, these tests can be executed using ```make test``` +The library includes a number of tests which illustrate use of both C and C++ interfaces. These can be found in the test folder. After building the library, these tests can be executed using: +```bash +make test -j`nproc` +```