Skip to content
Snippets Groups Projects

Readme fix. Added TOC

Merged Readme fix. Added TOC
(removed):readme_fix into master
Merged Whitney Armstrong requested to merge (removed):readme_fix into master
Compare
and
2 files
+ 40
− 14
Compare changes
  • Side-by-side
  • Inline
Files
2
examples/README.md
+ 19
− 12
NPdet Examples
NPdet Examples
==============
==============
Contents
* [Introduction](#introduction)
--------
* [How to build a detector from scratch](#how-to-build-a-detector-from-scratch)
+ [Compiling a new detector](#compiling-a-new-detector)
1. [Introduction](#introduction)
+ [Building the geometry](#building-the-geometry)
2. [How to build a detector from scratch](#how-to-build)
- [Compact detector description entry element](#compact-detector-description-entry-element)
3. [Simple Reconstruction Overview](#overview)
- [Geometry Construction](#geometry-construction)
* [XML Parsing Tip : Provide good default values](#xml-parsing-tip--provide-good-default-values)
<a name="introduction"></a> Introduction
- [Critical parts of build_detector](#critical-parts-of-build_detector)
----------------------------------------
* [The Readout and Bit Fields](#the-readout-and-bit-fields)
 
* [Simple Reconstruction Overview of scripts](#simple-reconstruction-overview-of-scripts)
 
+ [Dependencies](#dependencies)
 
+ [Running the scripts](#running-the-scripts)
 
+ [To Do](#to-do)
 
 
Introduction
 
------------
To a newcomer it might not be immediately clear why a *generic detector
To a newcomer it might not be immediately clear why a *generic detector
library* based on `dd4hep` is a good solution to the 'simulation and
library* based on `dd4hep` is a good solution to the 'simulation and
@@ -28,7 +35,7 @@ executed using any tool available, however, the IO and data model should be
@@ -28,7 +35,7 @@ executed using any tool available, however, the IO and data model should be
fixed.
fixed.
<a name="how-to-build"></a>How to build a detector from scratch
How to build a detector from scratch
------------------------------------
------------------------------------
Building a new (generic) detector using dd4hep is rather straight forward if we
Building a new (generic) detector using dd4hep is rather straight forward if we
@@ -322,8 +329,8 @@ The Readout and Bit Fields
@@ -322,8 +329,8 @@ The Readout and Bit Fields
--------------------------
--------------------------
<a name="overview"></a>Simple Reconstruction Overview of scripts
Simple Reconstruction Overview of scripts
-------------------
---------------------------------------
In the examples here we use ROOT and the LCIO data model.
In the examples here we use ROOT and the LCIO data model.
The following scripts should be executed in order:
The following scripts should be executed in order: