Skip to content

Update README.md with copy edits, fixes typos, updates make command #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md with copy edits, fixes typos, updates make command #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
```