Skip to content

Commit 780d507

Browse files
committed
Updated readme and new version number
1 parent 48d11d1 commit 780d507

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cmake_minimum_required(VERSION 3.15)
2-
project(XIA2tree VERSION 1.3.1 LANGUAGES C CXX)
2+
project(XIA2tree VERSION 1.4.0 LANGUAGES C CXX)
33

44
# Default to the project version when git information is unavailable
55
set(FULL_VERSION "${PROJECT_VERSION}")

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
XIA2tree is a package for sorting XIA list mode data from experiments at the Oslo Cyclotron Laboratory (OCL).
66
It reads raw digitizer data, applies detector-specific calibration and time/event building, and produces ROOT histograms and optionally ROOT TTrees for further physics analysis.
77

8-
### What XIA2tree does
8+
## What XIA2tree does
99
At a high level, XIA2tree:
1010

1111
- Reads one or more raw XIA list-mode files and interprets the DAQ words.
@@ -16,7 +16,7 @@ At a high level, XIA2tree:
1616

1717
For a more detailed description of the internal pipeline and data flow, see [`docs/architecture.md`](docs/architecture.md).
1818

19-
### Installing
19+
## Installing
2020
The `XIA2tree` project can be downloaded from a custom Homebrew tap. To install follow these steps:
2121
1) Add the custom repo(tap):
2222
```bash
@@ -29,7 +29,7 @@ brew install xia2tree
2929
Note that to install the three first letters are not capitalized, while when running the software from command line you
3030
need to captialize the first three letters.
3131

32-
### Building
32+
## Building from source
3333
The `XIA2tree` project has a minimal number of dependencies. You only need `ROOT` and `CMake` installed on your computer.
3434

3535
To build:
@@ -75,7 +75,7 @@ XIA2tree -i /path/to/raw/file(s) -o output_file.root -C /path/to/config_calibrat
7575

7676
See `docs/usage.md` for step-by-step usage examples and common workflows.
7777

78-
### Command line options
78+
## Command line options
7979

8080
In addition to the minimal example, there are more options:
8181

@@ -121,7 +121,7 @@ The timing and event-building options are:
121121

122122
See [`docs/architecture.md`](docs/architecture.md) for how these parameters affect the internal pipeline.
123123

124-
### Configuration and calibration file
124+
## Configuration and calibration file
125125
The sorting code requires a calibration/configuration file.
126126
This file describes the data acquisition system, the number of detectors, which detectors are connected to which DAQ channels, and the calibration of the detectors.
127127

@@ -132,7 +132,10 @@ Examples of these files are:
132132

133133
A more detailed description of the expected YAML structure (including `setup`, `calibration`, `analysis`, and `user_parameters` sections) is available in [`docs/usage.md`](docs/usage.md).
134134

135-
### Further documentation
135+
## License
136+
See [License](LICENSE).
137+
138+
## Further documentation
136139

137140
- [`docs/architecture.md`](docs/architecture.md): internal architecture and data flow (pipeline stages, threads, queues, ROOT output).
138141
- [`docs/usage.md`](docs/usage.md): detailed usage examples, YAML configuration structure, and recommended workflows.

0 commit comments

Comments
 (0)