From 167205c109291aa1957ba64667efa12ce53bba5d Mon Sep 17 00:00:00 2001 From: Daniel Silverstone Date: Sat, 19 Nov 2016 09:39:07 +0000 Subject: Add missing files --- COPYING | 20 ++++++++++++++++++++ README | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) create mode 100644 COPYING create mode 100644 README diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..a90a8a7 --- /dev/null +++ b/COPYING @@ -0,0 +1,20 @@ +Copyright (C) 2009-2016 Vincent Sanders +Copyright (C) 2009-2016 Michael Drake + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + + * The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README b/README new file mode 100644 index 0000000..732e850 --- /dev/null +++ b/README @@ -0,0 +1,45 @@ +Libnsfb - NetSurf Framebuffer Library +===================================== + +Overview +-------- + + Libnsfb is a framebuffer drawing library with a simple interface, + providing a consistent API across a number of framebuffer implementations. + +Requirements +------------ + + Libnsfb requires the following tools: + + + A C99 capable C compiler + + GNU make or compatible + + Pkg-config + + Libnsfb also requires the following libraries to be installed: + + + SDL 1.2 (for the SDL backend) + + libxcb* (for the X11 backend) + +Compilation +----------- + + If necessary, modify the toolchain settings in the Makefile. + Invoke make: + $ make + +Verification +------------ + + To verify that the parser is working, it is necessary to specify a + different makefile target than that used for normal compilation, thus: + + $ make test + +API documentation +----------------- + + Currently, there is none. However, the code is well commented and the + public API may be found in the "include" directory. The testcase sources + may also be of use in working out how to use it. + -- cgit v1.2.3