freundlich/fcppt — Issue #2: Lack of README file
Author: ruediger
Created: 2012-02-17 12:07:54+00:00
State: open

Your project looks great but it lacks a README file making it harder to get a quick understanding of the purpose of your library, how to build it and where to contact you or get help/more information.

Example README

# Freundlich's C++ Toolkit: fcppt

Boost already is a very useful general purpose library. If you use C++ without boost, the need for something that is already provided by it will soon arise. However, boost is not perfect (and Freundlich's C++ toolkit isn't either). The need for something that isn't provided by boost might arise, too, and there are even some things I consider not done "well" in boost. Freundlich's C++ toolkit (from now on shortened to fcppt) tries to fill in some gaps left by boost and even implements some replacements for a few boost components.

See http://fcppt.net or https://github.com/freundlich/fcppt for more information and current versions.

# Build
## Requirements
* C++ Compiler
...

## Build instructions
...