poco/README.md

73 lines
2.8 KiB
Markdown
Raw Normal View History

2018-03-07 17:35:20 +01:00
![alt text][logo]
2015-01-19 14:43:59 +01:00
2020-01-12 18:16:47 +01:00
[![Travis Build Status](https://travis-ci.org/pocoproject/poco.png?branch=poco-1.10.0)](https://travis-ci.org/pocoproject/poco)
[![Build status](https://ci.appveyor.com/api/projects/status/7iyrx3f233s3akae/branch/poco-1.10.0?svg=true)](https://ci.appveyor.com/project/obiltschnig/poco/branch/poco-1.10.0)
2018-03-07 17:35:20 +01:00
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/370/badge)](https://bestpractices.coreinfrastructure.org/projects/370)
2015-01-19 14:43:59 +01:00
2016-03-12 16:42:25 +01:00
2020-01-27 09:07:10 +01:00
### POCO (Portable Components) C++ Libraries are:
2018-03-08 10:55:58 +01:00
2020-01-27 09:07:10 +01:00
- A collection of C++ class libraries, conceptually similar to the Java Class Library or the .NET Framework.
2013-06-05 06:16:05 +02:00
- Focused on solutions to frequently-encountered practical problems.
2020-01-27 09:07:10 +01:00
- Focused on "internet-age" network-centric applications.
2013-06-05 06:16:05 +02:00
- Written in efficient, modern, 100% ANSI/ISO Standard C++.
- Based on and complementing the C++ Standard Library/STL.
2017-11-10 14:14:19 +01:00
- Highly portable and available on many different platforms, from embedded to server.
2016-03-12 16:42:25 +01:00
- Open Source, licensed under the [Boost Software License](https://spdx.org/licenses/BSL-1.0).
2018-03-07 17:35:20 +01:00
![alt text][overview]
2017-11-10 14:14:19 +01:00
To start using POCO, see the [Guided Tour](https://pocoproject.org/docs/00100-GuidedTour.html)
and [Getting Started](https://pocoproject.org/docs/00200-GettingStarted.html) documents.
2014-10-14 03:26:02 +02:00
2020-01-27 09:07:10 +01:00
## Quick Start (with CMake)
### Prerequisites
- CMake 3.5 or newer
- A C++14 compiler (Visual C++ 2015, GCC 5.0, Clang 3.4, or newer)
- OpenSSL headers and libraries (optional, but recommended; on macOS, via Homebrew: `brew install openssl`)
### Building
```
$ git clone -b master https://github.com/pocoproject/poco.git
$ cd poco
$ mkdir cmake-build
$ cd cmake-build
$ cmake .. && cmake --build .
```
You can also run:
```
$ sudo cmake --build . --target install
```
in the `cmake-build` directory to install POCO (default `/usr/local` on Linux or macOS).
If you do not want to or cannot use CMake, POCO can also be built with Visual Studio
(project and solution files included) or GNU Make.
Please refer to the [documentation](https://pocoproject.org/docs) for more information.
POCO can also be obtained via different [package managers](https://pocoproject.org/download.html).
## Community and Contributing
POCO has an active user and contributing community, please visit our [website](https://pocoproject.org) and [blog](https://pocoproject.org/blog).
2016-09-13 07:42:41 +02:00
Answers to POCO-related questions can also be found on [Stack Overflow](https://stackoverflow.com/questions/tagged/poco-libraries).
Please see [CONTRIBUTING](CONTRIBUTING.md) for submitting contributions, bugs reports, feature requests or security issues.
2013-06-05 06:16:05 +02:00
2020-01-27 09:07:10 +01:00
### POCO vs. Boost
2014-10-14 03:26:52 +02:00
In regards to Boost, in spite of some functional overlapping,
POCO is best thought of as a Boost complement (rather than replacement).
2016-03-12 16:42:25 +01:00
Side-by-side use of Boost and POCO is a very common occurrence.
2013-06-05 06:16:05 +02:00
2018-03-08 10:55:58 +01:00
[overview]: doc/images/overview.png "Poco Overview"
[logo]: doc/images/logo.png "Poco Logo"