iLCSoft Documentation

This package provides some minimal documentation for the iLCSoft project on GitHub. You can find more details about ilcsoft itself at:

• http://ilcsoft.desy.de/portal

  • please note that we are currently also re-organizing the documentation and have started to move it to Github as well

Code documentation

Many iLCSoft packages have API documentation generated from the code - see ./CodeDocumentation.md.

List of packages maintained on GitHub

All packages in the iLCSoft GitHub project are now fully maintained on GitHub. Some remaining packages, e.g. for test beams, are still maintained on svn. Contact us, if you want your package to also be included in the iLCSoft GitHub project.

Some ilcsoft packages are maintained in related GitHub projects:

• AidaSoft/DD4hep
• AidaSoft/aidaTT
• lcfiplus/LCFIPlus
• FCALSW/FCalClusterer

Overview of Open Issues and PullRequests

Dashboard

Contributing to iLCSoft packages

If you want to contribute to iLCSoft packages on GitHub, fork the corresponding project and create a pull request with your proposed changes. Please see the contribution guidelines.

Tutorial for using git (and GitHub)

If you are new to git and GitHub, have a look at this tutorial:

• https://github.com/andresailer/tutorial

A Brief Introduction for how to use ILCSoft packages

If you are a new user for iLCSoft, here is a brief introduction for how to use ILCSoft packages