Skip to content
Template for LinkSmart repos
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE Initial commit Aug 1, 2019
NOTICE Create NOTICE Sep 5, 2019
README.md

README.md

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.

An optional teaser figure

Getting Started

Deployment

Docker

docker run -p 8080:80 foobar

Development

Prerequisite

This projects depends on XYZ. Installation instructions are available here

On Debian:

apt install xyz

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.

Notes

  • The above template is adapted from [1, 2, 3].
  • Versioning: Use Semantic Versioning and tag the repository with full version string. E.g. v1.0.0
  • Licensing:
    • 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 license.
    • Provide a NOTICE file at the top level of the source tree with the name of your project.

Remove this section from the actual readme.

You can’t perform that action at this time.