Table of contents

1. Introduction
2. Papers
3. Installation
4. Documentation
5. Examples
6. Acknowledgments
7. Other projects

Introduction

We write this README file using markdown. You can give here a brief description of the project. Maybe discuss the software organization within the project.

You can see how other people organize their projects here

1. UAMMD

2. Rigid multiblob

3. STKFMM

4. CUP3D

Papers

Papers describing or using the software. It is possible to include links like

1. Brownian Dynamics of Confined Rigid Bodies, S. Delong, F. Balboa Usabiaga, and A. Donev, The Journal of Chemical Physics, 143, 144107 (2015). DOI arXiv

Installation

List prerequisites (if necessary) and how to compile the code.

Documentation

Detailed documentation in doc.

Examples

List of examples with input files

1. Example 1: basic example one link

2. Example 2: basic example two link

Acknowledgments

Funding or people.