aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--COPYING.MIT2
-rw-r--r--README43
-rw-r--r--storm/config.py4
-rw-r--r--storm/xmlrpc.py2
4 files changed, 41 insertions, 10 deletions
diff --git a/COPYING.MIT b/COPYING.MIT
index 887304e..89de354 100644
--- a/COPYING.MIT
+++ b/COPYING.MIT
@@ -1,5 +1,3 @@
-Copyright (C) 2012 Intel Corporation
-
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
diff --git a/README b/README
index f2d5687..5fd740b 100644
--- a/README
+++ b/README
@@ -1,9 +1,42 @@
-# Storm
+Storm
+=====
-Storm is a control application for the Yocto Project blimp demo.
+Storm is the control application behind the Yocto Project blimp demo.
-This project depends on PyGTK and PyGST.
+Storm currently has the following capabilities:
+ - Remote control over IP
+ - Live video capture and streaming over IP
+ - Autopilot
-## License
+Dependencies
+------------
-Storm is made available under the MIT license.
+This project depends on GTK and gstreamer, each with their respective
+python bindings.
+The server component is designed to work with Gumstix's Robovero
+expansion board. Communication with the board is facilitated through
+use of their python library, available here
+(https://github.com/robovero/python).
+
+
+DSP Considerations
+------------------
+
+In order to get live video encoding working at a reasonable frame rate, it
+is necessary to leverage the on-board digital signal processor (DSP).
+Getting this setup is somewhat involved; you will be required to install
+some specialized libraries and set aside some physical memory to avoid
+conflicts between the DSP and kernel. After everything is in place you
+will be able to plug a DSP accelerated encoder directly into a gstreamer
+pipeline.
+
+A detailed walkthrough can be found here:
+http://jumpnowtek.com/index.php?option=com_content&view=article&id=81:gumstix-dsp-gstreamer&catid=35:gumstix&Itemid=67
+
+License
+-------
+
+Copyright (C) 2013 Intel Corporation
+
+Unless otherwise stated, Storm is made available under the MIT license. Please
+refer to LICENSE for more detail.
diff --git a/storm/config.py b/storm/config.py
index 469f0f5..87672aa 100644
--- a/storm/config.py
+++ b/storm/config.py
@@ -1,5 +1,5 @@
# Copyright (C) 2007 Free Software Foundation, Inc.
-# This file is part of Ajenti.
+# This file contains code that is adapted from Ajenti.
# Written by Eugeny Pankov, 2010-2011.
#
# Ajenti is free software; you can redistribute it and/or
@@ -13,7 +13,7 @@
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
-# License along with Ajenti; if not, see <http://www.gnu.org/licenses/>
+# License along with this file; if not, see <http://www.gnu.org/licenses/>
from ConfigParser import ConfigParser
import os
diff --git a/storm/xmlrpc.py b/storm/xmlrpc.py
index ac37d38..4105051 100644
--- a/storm/xmlrpc.py
+++ b/storm/xmlrpc.py
@@ -13,7 +13,7 @@
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
-# License along with Ajenti; if not, see <http://www.gnu.org/licenses/>
+# License along with this file; if not, see <http://www.gnu.org/licenses/>
import sys
import os