Skip to content

Commit

Permalink
Updated READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
racerxdl committed Nov 11, 2016
1 parent b885ce9 commit 5e357b3
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
2 changes: 1 addition & 1 deletion GOES/decoder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ It depends on **SatHelper** library either by a static link or shared link (see

![Screenshot](decoder.png)

To compile just go to any of the folders `Debug`, `Release` or `Release Static` and run `make`.
To compile just go to any of the folders `Debug`, `Release` or `Release Static` and run `make`. You can also use `Eclipse CDT` to compile the project.


Dependencies:
Expand Down
11 changes: 10 additions & 1 deletion SatHelper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,13 @@ Features
* CCSDS ReedSolomon Decode (wrapper from [libfec](https://github.com/quiet/libfec))
* ReedSolomon [De]Interleaver
* Correlator for Sync Word
* Packet Phase Ambiguity Fixer (For 0, 90, 180, 270 degrees and IQ Inversion)
* Packet Phase Ambiguity Fixer (For 0, 90, 180, 270 degrees and IQ Inversion)

How to build
============

This Library depends on [libfec](https://github.com/quiet/libfec). Please make sure you have it installed before trying to compile SatHelper.

The **libsathelper** can be compiled in three modes: `Debug Shared`, `Release Shared`, `Release Static`. The `static` and `shared` refers to the linking mode of the library (the shared will generate a **.so** file and static will generate a **.a** file). For example GOES LRIT Decoder have Shared and Static builds using **libsathelper**.

For compiling, just enter on one of the folders `Debug`, `Release`, `Release (Static)` and run `make`. You can also use `Eclipse CDT` to compile the project.

0 comments on commit 5e357b3

Please sign in to comment.