From b935988a4d200171fa7a15082816e8b904343ba1 Mon Sep 17 00:00:00 2001 From: Francesco Bertolaccini Date: Wed, 27 Jan 2016 19:05:23 +0100 Subject: [PATCH] Added README and LICENSE files --- LICENSE.md | 11 +++++++++++ README.md | 9 +++++++++ SharpPhysFS.sln | 6 ++++++ 3 files changed, 26 insertions(+) create mode 100644 LICENSE.md create mode 100644 README.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..f2825d8 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,11 @@ +# Copyright (c) 2016 Francesco Bertolaccini + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..a4f4786 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# SharpPhysFS +## PhysicsFS wrapper for .NET + +This library is a wrapper around the [PhysFS library](https://icculus.org/physfs/) designed +to work with .NET languages. As such, it employs standard .NET behaviors such as *Exceptions* +and *IEnumerable*s to represent native objects. It also provides access to the underlying low-level +methods and a *Stream* subclass for easy use of the APIs. + +The documentation for the methods is copied from the original doxygen and only slightly adapted. \ No newline at end of file diff --git a/SharpPhysFS.sln b/SharpPhysFS.sln index fc6f5a4..b89ce99 100644 --- a/SharpPhysFS.sln +++ b/SharpPhysFS.sln @@ -5,6 +5,12 @@ VisualStudioVersion = 14.0.24720.0 MinimumVisualStudioVersion = 10.0.40219.1 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SharpPhysFS", "SharpPhysFS\SharpPhysFS.csproj", "{AD6AA182-8C7F-4F3A-AAEF-7BD993D1D262}" EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{250EE88E-18B5-4433-ACF0-24A1D81429CF}" + ProjectSection(SolutionItems) = preProject + LICENSE.md = LICENSE.md + README.md = README.md + EndProjectSection +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU