Skip to content

Commit

Permalink
Add repo readme.markdown.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sibras committed Apr 13, 2017
1 parent a3d5d4e commit 82af5db
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 0 deletions.
39 changes: 39 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
ShiftMediaProject SoX Resampler
=============
[![Build status](https://ci.appveyor.com/api/projects/status/kw9ijne5qy5in6w1?svg=true)](https://ci.appveyor.com/project/Sibras/soxr)
[![Github All Releases](https://img.shields.io/github/downloads/ShiftMediaProject/soxr/total.svg)](https://github.com/ShiftMediaProject/soxr/releases)
[![GitHub release](https://img.shields.io/github/release/ShiftMediaProject/soxr.svg)](https://github.com/ShiftMediaProject/soxr/releases/latest)
[![GitHub issues](https://img.shields.io/github/issues/ShiftMediaProject/soxr.svg)](https://github.com/ShiftMediaProject/soxr/issues)
[![license](https://img.shields.io/github/license/ShiftMediaProject/soxr.svg)](https://github.com/ShiftMediaProject/soxr)
[![donate](https://img.shields.io/badge/donate-link-brightgreen.svg)](https://shiftmediaproject.github.io/8-donate/)
## ShiftMediaProject

Shift Media Project aims to provide native Windows development libraries for soxr and associated dependencies to support simpler creation and debugging of rich media content directly within Visual Studio. [https://shiftmediaproject.github.io/](https://shiftmediaproject.github.io/)

## SoX Resampler

A library for performing one-dimensional sample-rate conversion. [https://sourceforge.net/projects/soxr/](https://sourceforge.net/projects/soxr/)

## Downloads

Development libraries are available from the [releases](https://github.com/ShiftMediaProject/soxr/releases) page. These libraries are available for each supported Visual Studio version (2013, 2015 or 2017) with a different download for each version. Each download contains both static and dynamic libraries to choose from in both 32bit and 64bit versions.

## Code

This repository contains code from the corresponding upstream project with additional modifications to allow it to be compiled with Visual Studio. New custom Visual Studio projects are provided within the 'SMP' sub-directory. Refer to the 'readme' contained within the 'SMP' directory for further details.

## Issues

Any issues related to the ShiftMediaProject specific changes should be sent to the [issues](https://github.com/ShiftMediaProject/soxr/issues) page for the repository. Any issues related to the upstream project should be sent upstream directly (see the issues information of the upstream repository for more details).

## License

ShiftMediaProject original code is released under [GPLv2](https://www.gnu.org/licenses/gpl-2.0.html). All code from the upstream repository remains under its original license (see the license information of the upstream repository for more details).

## Copyright

As this repository includes code from upstream project(s) it includes many copyright owners. ShiftMediaProject makes NO claim of copyright on any upstream code. However, all original ShiftMediaProject authored code is copyright ShiftMediaProject. For a complete copyright list please checkout the source code to examine license headers. Unless expressly stated otherwise all code submitted to the ShiftMediaProject project (in any form) is licensed under [GPLv2](https://www.gnu.org/licenses/gpl-2.0.html) and copyright is donated to ShiftMediaProject. If you submit code that is not your own work it is your responsibility to place a header stating the copyright.

## Contributing

Patches related to the ShiftMediaProject specific changes should be sent as pull requests to the main repository. Any changes related to the upstream project should be sent upstream directly (see the contributing information of the upstream repository for more details).
6 changes: 6 additions & 0 deletions SMP/readme.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

This is a small list of steps in order to build soxr into a msvc DLL and lib file.

The project contains Release and Debug builds for static lib files (Debug/Release)
as well as dynamic shared dll files (DebugDLL/ReleaseDLL).
Choose whichever project configuration meets your requirements.

0 comments on commit 82af5db

Please sign in to comment.