Skip to content

Commit 6a02b4d

Browse files
committed
edit README.md content
1 parent 447030f commit 6a02b4d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Susa is a mathematics and signal processing C++ [framework](https://en.wikipedia
88
Java based mobile applications. Susa is also a simulation framework for the researchers and engineers who design
99
computational systems. It has linear algebra, signal processing and common communications blocks.
1010

11-
The *matrix* and *array* template classes i.e. types are at the heart of Susa bundled with a constellation of classes and functions. A *vector* is simply a single column (or a single row) matrix.
11+
The *matrix* and *array* template classes i.e. types are at the heart of Susa. A *vector* is simply a single column (or a single row) matrix. It is bundled with a constellation of classes and functions.
1212

1313
### Highlights
1414
- Algebraic types (template classes): *matrix* and multi-dimensional *array*.
@@ -49,6 +49,8 @@ to be able to build against Susa system-wide. However, you may continue using th
4949
## Examples
5050
In the [examples](https://github.com/behrooza/susa/tree/master/examples) directory
5151
a number of simulation and tutorial source codes have been provided.
52+
## Contribution
53+
This is a non-profit project and it belongs to its users. You can contribute to your project by reporting bugs and extending it by following the provided [guidelines](https://guides.github.com/activities/forking). This paves the way for further improvements and protects the authors' rights.
5254
## History
5355
Susa was born in April 2008 out of a university project course in digital communications.
5456
At the time the libraries that could be used for digital communications simulation had
@@ -60,7 +62,7 @@ in November 2008.
6062

6163
Later in early 2009, Susa was used for a bandwidth efficient coding scheme, namely,
6264
[Faster Than Nyquist (FTN)](http://www.eit.lth.se/fileadmin/eit/courses/eit085f/AndersonFasterThanNyquistSignaling.pdf).
63-
It required prefermant equalizers to decode up to some twenty taps (compared to the fading channels with few taps).
65+
It required preferment equalizers to decode up to some twenty taps (compared to the fading channels with few taps).
6466
The simulation of such systems took a long time between an hour to a few days. This library could simulate
6567
a FTN system with thirteen taps using a modified BCJR algorithm (a sub-optimal variant that could outperform
6668
the original algorithm) in about an hour whereas a similar script in a commercial computing software took

0 commit comments

Comments
 (0)