11IPP Sample Implementations
22==========================
33
4- This code provides sample, non-production-ready implementations of IPP Clients,
5- Printers, Proxies, and Systems. It makes use of the [ CUPS Library v3] [ LIBCUPS ]
6- and [ PDFio library] [ PDFIO ] projects to provide low-level HTTP, IPP, and PDF
7- support. The ` ippserver ` and ` ipp3dprinter ` code was also inspired by the
8- original CUPS ` ippeveprinter ` source code.
4+ This project provides non-production-ready sample code implementations of IPP
5+ Clients, Printers, Proxies, and Systems. It makes use of the
6+ [ CUPS Library v3] [ LIBCUPS ] and [ PDFio library] [ PDFIO ] projects to provide low-
7+ level HTTP, IPP, and PDF support. The ` ippserver ` and ` ipp3dprinter ` code was
8+ inspired by the original CUPS ` ippeveprinter ` source code but is separately
9+ developed and maintained.
910
1011![ Version] ( https://img.shields.io/github/v/release/istopwg/ippsample?include_prereleases )
1112![ Apache 2.0] ( https://img.shields.io/github/license/istopwg/ippsample )
1213![ Build and Test] ( https://github.com/istopwg/ippsample/workflows/Build%20and%20Test/badge.svg )
1314![ ipp] ( https://snapcraft.io/ipp/badge.svg )
1415![ Coverity Scan Status] ( https://img.shields.io/coverity/scan/22384.svg )
1516
16- > Note: This code is provided for educational purposes only. While we will make
17+ > * Note:* This code is provided for educational purposes only. While we make
1718> every effort to ensure the code is bug-free and regularly run the code
18- > through dynamic and static analysis tools, it is written for correctness, not
19- > performance, and so is not intended for use as a production solution. This
20- > code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
21- > ANY KIND, either express or implied.
19+ > through dynamic and static analysis tools, it is written for correctness,
20+ > not performance, and so is not intended for use or supported as a production
21+ > solution. This code is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
22+ > OR CONDITIONS OF ANY KIND, either express or implied.
2223
2324
2425Getting the Code
@@ -28,8 +29,9 @@ Getting the Code
2829* main project page, as that archive is missing the libcups and PDFio submodules*
2930* and will not compile.*
3031
31- The source code is available in semi-monthly release tarballs or via the Github
32- repository. For a release tarball, run the following commands:
32+ The source code is available in semi-monthly (non-production) release tarballs
33+ or via the Github repository. For a release tarball, run the following
34+ commands:
3335
3436 tar xvzf ippsample-VERSION.tar.gz
3537 cd ippsample-VERSION
@@ -103,6 +105,7 @@ The following documentation files may be of use as well:
103105- ` INSTALL.md ` : Detailed build instructions
104106- ` PI.md ` : How to build ippsample for various Raspberry Pi boards
105107- ` SCRIPTING.md ` : How to use the ippserver REST API
108+ - ` SECURITY.md ` : The security policy for this project
106109- ` TESTING.md ` : How to test ippserver with the sample configuration under the
107110 ` test ` subdirectory
108111- ` man/* ` : Man pages for each of the ippsample programs in nroff and HTML
0 commit comments