Browse Source

Update 'README.md'

master
Blake Leverington 1 year ago
parent
commit
9bceb6f24e
  1. 25
      README.md

25
README.md

@ -7,8 +7,10 @@ Files for building readout software for the TDC-GPX2 from ScioSense.
| ------ | ----------- |
| source/gpx2-raspi-readout-program| Contains a readout loop, buffer and calculations to measure time intervals between two signals with good accuracy.
| source/spi | Folder containing gpx2 source files for making the tdc board library containing all options and an high level access for readout.
| source/gpx2-fpga | tba |
| scripts | python script makes a histogram of the output. requires matplotlib|
| data | empty folder for output|
<br>
<strong>Readout via SPI:</strong>
Required:
@ -16,9 +18,22 @@ Required:
- up-to-date c++ compiler (C++17 compatible), tested with clang 11 and newer
How to build:
- This software packages is build with cmake
- requires cmake
- builds the gpx2 library and optionally the readout program
<br>
<strong>Readout via LVDS using an FPGA:</strong><br>
coming soon
```sh
cd source
mkdir build
cd build
cmake ..
cmake --build .
```
to run the code:
```
/// outputs to stdout
./bin/readout
///redirect to file
./bin/readout > ../data/test_out.data
```
Loading…
Cancel
Save