Skip to content

Commit

Permalink
Build & Documentation
Browse files Browse the repository at this point in the history
* Eliminate old versions of Mono from Travis CI
* Add MacOSX as a build OS for Travis CI
* Tweak AppVeyor YAML
* Updated layout of README.md
* Created .github directory for Issue & PR templates
  • Loading branch information
McNeight committed Apr 12, 2016
1 parent 417703b commit 459eecb
Show file tree
Hide file tree
Showing 7 changed files with 80 additions and 33 deletions.
2 changes: 1 addition & 1 deletion Documentation/CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thanks for helping to improve SharpZipLib.

In order for your changes to be accepted you can either sign the [Joint Copyright Assignment](http://www.icsharpcode.net/TechNotes/JointCopyrightAssignment.pdf) or add the following statement to your pull request:

_I certify that I own, and have sufficient rights to contribute, all source code and related material intended to be compiled or integrated with the source code for the #ziplib open source product (the "Contribution"). My Contribution is licensed under the MIT License._
_I certify that I own, and have sufficient rights to contribute, all source code and related material intended to be compiled or integrated with the source code for the SharpZipLib open source product (the "Contribution"). My Contribution is licensed under the MIT License._

Unless we have a Joint Copyright Agreement on file or this statement is in your pull request, we cannot accept it.

Expand Down
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
### Steps to reproduce
1.
2.
3.

### Expected behavior
Tell us what should happen

### Actual behavior
Tell us what happens instead

### Version of SharpZipLib

### Obtained from (place an x between the brackets for all that apply)
- [ ] Compiled from source
- branch: _______
- commit: _______
- [ ] Downloaded DLL from GitHub
- [ ] Downloaded DLL from SourceForge
- [ ] Downloaded DLL from _______
- [ ] DLL included as part of
- Package installed using:
- [ ] NuGet
- [ ] MyGet
- [ ] Chocolatey
4 changes: 4 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!---
Please remember that unless we have a Joint Copyright Agreement on file or the following statement is in your pull request, we cannot accept it.
-->
_I certify that I own, and have sufficient rights to contribute, all source code and related material intended to be compiled or integrated with the source code for the SharpZipLib open source product (the "Contribution"). My Contribution is licensed under the MIT License._
7 changes: 4 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
language: csharp
mono:
- latest
- 3.12.0
- 2.10.8
- 4.2.3
os:
- linux
- osx
solution: ICSharpCode.SharpZipLib.sln
#install:
# - nuget restore ICSharpCode.SharpZipLib.sln
Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing to SharpZipLib

Thanks for helping to improve SharpZipLib.

In order for your changes to be accepted you can either sign the [Joint Copyright Assignment](http://www.icsharpcode.net/TechNotes/JointCopyrightAssignment.pdf) or add the following statement to your pull request:

_I certify that I own, and have sufficient rights to contribute, all source code and related material intended to be compiled or integrated with the source code for the SharpZipLib open source product (the "Contribution"). My Contribution is licensed under the MIT License._

Unless we have a Joint Copyright Agreement on file or this statement is in your pull request, we cannot accept it.

More information is available on [joining the team](https://github.com/icsharpcode/SharpDevelop/wiki/Joining-the-Team).
58 changes: 32 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,40 @@
# SharpZipLib

[![Build Status](https://travis-ci.org/McNeight/SharpZipLib.svg?branch=build)](https://travis-ci.org/McNeight/SharpZipLib)
[![Build status](https://ci.appveyor.com/api/projects/status/oe7kwnaib3qscm8l/branch/build?svg=true)](https://ci.appveyor.com/project/McNeight/SharpZipLib/branch/build)

\#ziplib (SharpZipLib, formerly NZipLib) is a **Zip, GZip, Tar and BZip2 library** written entirely in C\# for the .NET framework. It is implemented as an assembly (installable in the GAC), and thus can easily be incorporated into other projects (in any .NET language). The creator of #ziplib put it this way: "I've ported the zip library over to C\# because I needed gzip/zip compression and I didn't want to use libzip.dll or something like this. I want all in pure C\#."
[![Join the chat at https://gitter.im/icsharpcode/SharpZipLib](https://badges.gitter.im/icsharpcode/SharpZipLib.svg)](https://gitter.im/icsharpcode/SharpZipLib?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

<table>
<tr>
<th style="text-align:center">Build Server</th>
<th>Operating System</th>
<th>Framework</th>
<th style="text-align:center">Status</th>
</tr>
<tr>
<td style="text-align:center">AppVeyor</td>
<td>Windows Server 2012</td>
<td>.NET Framework 4.5</td>
<td style="text-align:center">[![Build status](https://ci.appveyor.com/api/projects/status/oe7kwnaib3qscm8l/branch/build?svg=true)](https://ci.appveyor.com/project/McNeight/SharpZipLib/branch/build)</td>
</tr>
<tr>
<td style="text-align:center" rowspan="2">Travis</td>
<td>Linux</td>
<td>Mono 4.2.3</td>
<td style="text-align:center" rowspan="2">[![Build Status](https://travis-ci.org/McNeight/SharpZipLib.svg?branch=build)](https://travis-ci.org/McNeight/SharpZipLib)</td>
</tr>
<tr>
<td>OSX</td>
<td>Mono 4.2.3</td>
</tr>
</table>

SharpZipLib (\#ziplib, formerly NZipLib) is a **Zip, GZip, Tar and BZip2 library** written entirely in C\# for the .NET framework. It is implemented as an assembly (installable in the GAC), and thus can easily be incorporated into other projects (in any .NET language). The creator of SharpZipLib put it this way: "I've ported the zip library over to C\# because I needed gzip/zip compression and I didn't want to use libzip.dll or something like this. I want all in pure C\#."

Introduction
------------

SharpZipLib was originally ported from the [GNU Classpath](http://www.gnu.org/software/classpath/) java.util.zip library for use with [SharpDevelop](http://www.icsharpcode.net/OpenSource/SD), which needed gzip/zip compression. bzip2 compression and tar archiving were added later due to popular demand.

There is a web site from which You can download the assembly and/or the source code (<http://icsharpcode.net/OpenSource/SharpZipLib>). A forum is also available at http://community.sharpdevelop.net/forums/12/ShowForum.aspx.

Please see the [\#ziplib homepage](http://icsharpcode.github.io/SharpZipLib/) for precompiled downloads, license information, link to the forum (support), release history, samples and more.
The [SharpZipLib homepage](http://icsharpcode.github.io/SharpZipLib/) has precompiled libraries available for download, [a link to the forum for support](http://community.sharpdevelop.net/forums/12/ShowForum.aspx), release history, samples and more.

License
-------
Expand All @@ -23,19 +45,6 @@ This software is released under the [GNU General Public License, version 2](http
>As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.
Building the library
--------------------

There are multiple ways to build this library, however the library build is tested with the following methods:

[AppVeyor](https://ci.appveyor.com/project/McNeight/SharpZipLib/branch/build)

This builds SharpZipLib on Windows useing Visual Studio 2013 and Visual Studio 2015

[Travis CI](https://travis-ci.org/McNeight/SharpZipLib)

This builds SharpZipLib on Linux with Mono 2.10.8, 3.12.1, and the latest version available

Namespace layout
----------------

Expand All @@ -51,17 +60,14 @@ Namespace layout
|Inflater/Deflater|ICSharpCode.SharpZipLib.Zip.Compression.\*|
|Inflater/Deflater streams|ICSharpCode.SharpZipLib.Zip.Compression.Streams.\*|

Reporting Bugs/Submit Patches
-----------------------------

Credits
-------

\#ziplib was initially been developed by [Mike Krueger](http://www.icsharpcode.net/pub/relations/krueger.aspx), however, much existing Java code helped a lot in speeding the creation of this library. Therefore credits fly out to other people.
SharpZipLib was initially developed by [Mike Krüger](http://www.icsharpcode.net/pub/relations/krueger.aspx). Past maintainers are John Reilly and David Pierson. The current maintainer is Neil McNeight.

The current maintainer of \#ziplib is David Pierson. Please contact him regarding features, bugs etc via the [forum](http://community.sharpdevelop.net/forums/12.aspx).
Much existing Java code helped to speed the creation of this library. Therefore credits fly out to other people.

Zip/Gzip implementation:
Zip/GZip implementation:

A Java version of the zlib which was originally created by the [Free Software Foundation (FSF)](http://www.fsf.org). So all credits should go to the FSF and the authors who have worked on this piece of code.

Expand Down
6 changes: 3 additions & 3 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ branches:
# whitelist
only:
- build

# blacklist
except:
- gh-pages
Expand Down Expand Up @@ -65,8 +65,8 @@ assembly_info:
patch: true
file: '**\AssemblyInfo.*'
assembly_version: '{version}'
assembly_file_version: '{version}'
assembly_informational_version: '{version}'
# assembly_file_version: '{version}'
# assembly_informational_version: '{version}'

build:
project: ICSharpCode.SharpZipLib.sln
Expand Down

0 comments on commit 459eecb

Please sign in to comment.