Foobar

Foobar is not a real software. The name is used here as placeholder for a described software. This readme is meant for describing an application but can be adapted to describe a software library by changing Deployment section to Usage.

Getting Started

The project documentation is available on the Wiki.

Deployment

Docker

To run the latest version of foobar:

docker run -p 8080:80 foobar

Development

Prerequisite

This projects depends on xyz. Installation instructions are available here

On Debian:

apt install xyz

Test

Use tests.sh to run unit tests:

sh tests.sh

Build

g++ -o app app.cpp

Contributing

Contributions are welcome.

Please fork, make your changes, and submit a pull request. For major changes, please open an issue first and discuss it with the other authors.

Affiliation

This work is supported by the European Commission through the CPSwarm H2020 project under grant no. 731946.

Notes

• The above templace is adapted from [1, 2, 3].
• Versioning: Use SemVer and tag the repository with full version string. E.g. v1.0.0
• License: Provide a LICENSE file at the top level of the source tree. You can use Github to add a license. This template repository has an Apache 2.0 file.

Remove this section from the actual readme.