Skip to content
Browse files

add contributing instructions and liberal license

  • Loading branch information...
1 parent d392484 commit 003e4353d9ee84a53f41ca28e689505e01a0a7b0 @bkw committed Oct 14, 2012
Showing with 58 additions and 0 deletions.
  1. +39 −0 CONTRIBUTING.md
  2. +19 −0 LICENSE
View
39 CONTRIBUTING.md
@@ -0,0 +1,39 @@
+# Contributing
+
+## Running the test suite
+
+```js
+$ git clone <git url>
+$ cd <clone dir>
+$ npm install -d
+$ npm test
+```
+
+## Running an individual test
+
+```js
+% ./node_modules/.bin/jasmine-node spec/drone-stream.spec.js
+```
+
+## TODOS
+
+Any help with making this module better is greatly appreciated.
+Especially the following areas need some love:
+
+* tweak fferserver.conf settings and ffmpeg arguments for less latency and/or
+ less cpu consumption
+
+* make the whole chain of TcpVideoStream -> Parser -> ffmpeg -> ffserver
+ more resilient (in descending order of priority);
+
+ * handle timeouts from tcpVideoStream
+
+ * handle errors from PaVEParser (invalid signature, search forward for next)
+
+ * handle unexpected exits from ffmpeg and restart
+
+ * handle ffserver exits
+
+Merging your improvements will be much smoother if you create a separate branch
+for every selfcontained feature and issue a pullreq from there.
+
View
19 LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2012 Bernhard K. Weisshuhn (bkw@codingforce.com) and contributors
+
+ 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.

0 comments on commit 003e435

Please sign in to comment.
Something went wrong with that request. Please try again.