Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FrankReiser authored Nov 26, 2023
1 parent 52e44b1 commit 85c3e44
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ faster than the legacy method and is comparable in spur free dynamic range. You
This component has been tested to be interface-able with C++20 compiles. Note that the compiled library code
is built using the c++11 standard. API/ABI stability will be maintained between minor versions of this project.

# Dependencies
This component has no dependencies other than those of C++11 standard library and "threads/pthreads" which
should be including in all Linux distributions.

# Thread Safety
This tone generator is not "thread safe". There are no concurrent access mechanisms
in place and there is no good reason for addressing this. To the contrary,
Expand All @@ -96,8 +100,10 @@ What I have done is to actually utilize std::complex instead of a discrete reimp
of complex math, fine honed the re-normalization period, and turned it into a reusable object that
meets my needs. Also, I provide some test harnesses that prove its worthiness.

## Building and Installation
Roughly as follows:
# Building and Installation
This project requires cmake version 3.15 or higher. The procedure for configuring and building is
roughly as follows:

1) Obtain a copy of the project
2) Create a build folder within the project root folder.
3) Switch directory to the build folder and run the following
Expand All @@ -117,3 +123,4 @@ Roughly as follows:
```
Please see the "tests" and "sundry" folders for examples on how to use the FlyingPhasor in
your own projects.

0 comments on commit 85c3e44

Please sign in to comment.