Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/peopleware/net-ppwcode-util-oddsandends

.NET library PPWCode.Util.OddsAndEnds
https://github.com/peopleware/net-ppwcode-util-oddsandends

Last synced: 3 days ago
JSON representation

.NET library PPWCode.Util.OddsAndEnds

Awesome Lists containing this project

README 

        
# PPWCode.Util.OddsAndEnds



This library is part of the PPWCode project and is a collection of several small helpers and utility code.



## Getting started



### PPWCode.Util.OddsAndEnds II



This is version II of the library, which is designed to work with Microsoft .NET 4.5 from the get-go.



The library is available as the [NuGet] package `PPWCode.Util.OddsAndEnds.II` in the [NuGet Gallery].  It can be installed using the Nuget package manager from inside Visual Studio.



### PPWCode.Util.OddsAndEnds I



Version I of the library is the original version of the library and is now in maintenance mode.



#### Support for .NET 3.5



The code was originally built against Microsoft .NET 3.5 and a version for .NET 3.5 is still available in the [NuGet Gallery].  It is the [NuGet] package `PPWCode.Util.OddsAndEnds.I` version 2.x.x.  Every 2.x.x version will be a maintenance release built against .NET 3.5.



Note that the 2.x.x versions depend on a [NuGet] package `Microsoft.Contracts`.  This is a package that cannot be published in the [NuGet Gallery], because it contains a proprietary dll from Microsoft.  It is really easy to create this package by yourself however.



#### Support for .NET 4.5



The more recent maintenance releases of `PPWCode.Util.OddsAndEnds.I`  are built against .NET 4.5.  Every release from 3.x.x onwards will be built against .NET 4.5.  These versions can be found on the git branch `stable/I`.  They are also published in the [NuGet Gallery].



## Build your own



A couple of reasons come to mind as to why you would want to build your own package of

this library. One reason would be that you need a version of the library built

with the debug configuration. Another reason might be that you need features

that are available on master, but that are not yet released.



Building your own package of this library is very easy.  A [psake] build script is

added for this purpose.



Before executing regular [psake] tasks, the environment must first be initialized.

To do this, open a PowerShell prompt, and execute the following in the root folder

of the source.



    .\init-psake.ps1



This will initialize your environment. Note that the script assumes that the

[NuGet] commandline client is available on the path.



After the initialization, several [psake] tasks can be executed using the

PowerShell command `Invoke-psake` that is available now. Here are a couple

of examples:



    Invoke-psake

    Invoke-psake ?

    Invoke-psake PackageRestore

    Invoke-psake Package -properties @{ 'configuration'='Debug'; 'repos'=@('nuget'); 'publishrepo' = 'local' }



The last line builds a [NuGet] package using the 'Debug' configuration, and publishes

it to the [NuGet] repository with the name 'local'. The [NuGet] repository 'nuget'

is used to locate the dependent [NuGet] packages.



## Contributors



See the [GitHub Contributors list].



## PPWCode



This package is part of the PPWCode project, developed by [PeopleWare n.v.].



More information can be found in the following locations:

* [PPWCode project website]

* [PPWCode Google Code website]



Please note that not all information on those sites is up-to-date. We are

currently in the process of moving the code away from the Google code

subversion repositories to git repositories on [GitHub].



### PPWCode .NET



Specifically for the .NET libraries: new development will be done on the

[PeopleWare GitHub repositories], and all new stable releases will also

be published as packages on the [NuGet Gallery].



We believe in Design By Contract and have good experience with

[Microsoft Code Contracts] and the related tooling.  As such, our packages

always include Contract Reference assemblies.  This allows you to also

benefit as a user from the contracts that are already included in the

library code.



The packages also include both the pdb and xml files, for debugging symbols

and documentation respectively.  In the future we might look into using

symbol servers.



## License and Copyright



Copyright 2014, 2015 by [PeopleWare NV].



Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at



http://www.apache.org/licenses/LICENSE-2.0



Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.



[PPWCode project website]: http://www.ppwcode.org

[PPWCode Google Code website]: http://ppwcode.googlecode.com



[PeopleWare NV]: http://www.peopleware.be/



[NuGet]: https://www.nuget.org/

[NuGet Gallery]: https://www.nuget.org/policies/About



[GitHub]: https://github.com

[PeopleWare GitHub repositories]: https://github.com/peopleware



[Microsoft Code Contracts]: http://research.microsoft.com/en-us/projects/contracts/



[GitHub Contributors list]: https://github.com/peopleware/net-ppwcode-util-oddsandends/graphs/contributors



[psake]: https://github.com/psake/psake