mirror/SDRPlusPlus
0
0
Fork 0
mirror of https://github.com/AlexandreRouma/SDRPlusPlus.git synced 2024-12-27 03:18:30 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #108 from KentuckyFriedData/patch-1

Browse Source 
Fixed typos and some grammar
This commit is contained in:
AlexandreRouma 2021-04-24 20:58:56 +02:00 committed by GitHub
commit e115161da8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
readme.md
View File

@ -27,7 +27,7 @@ SDR++ is a cross-platform and open source SDR software with the aim of being blo
## Windows ## Windows
Download the latest release from [the Releases page](https://github.com/AlexandreRouma/SDRPlusPlus/releases) and extract to the directory of your choice. Download the latest release from [the Releases page](https://github.com/AlexandreRouma/SDRPlusPlus/releases) and extract to the directory of your choice.
To create a desktop short, rightclick the exe and select `Send to -> Desktop (create shortcut)`, then, rename the shortcut on the desktop to whatever you want. To create a desktop shortcut, rightclick the exe and select `Send to -> Desktop (create shortcut)`, then, rename the shortcut on the desktop to whatever you want.
## Linux ## Linux
@ -82,7 +82,7 @@ cmake --build . --config Release
## Running for development ## Running for development
If you wish to install SDR++, skip to the next step If you wish to install SDR++, skip to the next step
You will first need to edit the `root_dev/config` file to point to the modules that were built. Here us a sample if what it would look like: You will first need to edit the `root_dev/config.json` file to point to the modules that were built. Here is an example of what it should look like:
```json ```json
... ...
@ -107,7 +107,7 @@ You also need to change the location of the resource and module directories, for
Remember that these paths will be relative to the run directory. Remember that these paths will be relative to the run directory.
Off cours, remember to add entries for all modules that were built and that you wish to use. Of course, remember to add entries for all modules that were built and that you wish to use.
Next, from the top directory, you can simply run: Next, from the top directory, you can simply run:
``` ```
@ -120,7 +120,7 @@ Or, if you wish to run from the build directory:
``` ```
## Installing SDR++ ## Installing SDR++
If you chose to run SDR++ for development, you do not need this step. If you choose to run SDR++ for development, you do not need this step.
First, copy over the exe and DLLs from `build/Release/` to `root_dev`. First, copy over the exe and DLLs from `build/Release/` to `root_dev`.
Next you need to copy over all the modules that were compiled. To do so, copy the DLL file of the module (located in its build folder given below) to the `root_dev/modules` directory and other DLLs (that do not have the exact name of the modue) to the `root_dev` directory. Next you need to copy over all the modules that were compiled. To do so, copy the DLL file of the module (located in its build folder given below) to the `root_dev/modules` directory and other DLLs (that do not have the exact name of the modue) to the `root_dev` directory.
@ -176,7 +176,7 @@ First run SDR++ from the build directory to generate a default config file
./sdrpp -r ../root_dev/ ./sdrpp -r ../root_dev/
``` ```
Then, you need to edit the `root_dev/config.json` file to point to the modules that were built. Here is a sample of what it should look like: Then, you will need to edit the `root_dev/config.json` file to point to the modules that were built. Here is an example of what it should look like:
```json ```json
... ...
@ -210,7 +210,7 @@ Next, from the top directory, you can simply run:
./build/sdrpp -r root_dev ./build/sdrpp -r root_dev
``` ```
Or, if you wish to run from the build directory, you need to correct directories in config.json, and: Or, if you wish to run from the build directory, you will need to correct the directories in the config.json file, and then run:
``` ```
./sdrpp -r ../root_dev ./sdrpp -r ../root_dev
``` ```
@ -223,7 +223,7 @@ sudo make install
# Contributing # Contributing
Feel free to issue pull request and report bugs via the github issues. Feel free to submit pull requests and report bugs via the GitHub issue tracker.
I will soon publish a contributing.md listing the code style to use. I will soon publish a contributing.md listing the code style to use.
# Credits # Credits