Permalink
Browse files

Updated INSTALL, README in preparation for prometheus

  • Loading branch information...
1 parent 863a303 commit d51a8cd2e16d5750e8dc51f961cdfad020e29c69 James Laver committed Mar 22, 2010
Showing with 42 additions and 26 deletions.
  1. +31 −9 INSTALL
  2. +11 −17 README
View
@@ -2,7 +2,32 @@ How to install get_iplayer
I assume a unix-like system. It's doable with strawberry perl too, but you'll probably need help from someone who uses it to get it working.
-If you don't want to install it and you just need to run it, here is all you have to do:
+There are two get_iplayers here and for each, instructions to install and run it, thus four sets of instructions.
+
+If you just want to use it, use the simple script. If you want to develop on it, use the new version
+
+INSTALLING THE SIMPLE SCRIPT
+
+1. Check out the latest version from git:
+
+git clone git://github.com/jjl/get_iplayer.git
+
+2. Copy it to somewhere sensible and chmod it
+
+sudo cp get_iplayer/get_iplayer /usr/local/bin
+sudo chmod 755 /usr/local/bin/get_iplayer
+
+RUNNING THE SIMPLE SCRIPT FROM WHERE IT IS
+
+1. Check out the latest version from git:
+
+git clone git://github.com/jjl/get_iplayer.git
+
+2. Run it.
+
+./get_iplayer.pl <args>
+
+RUNNING THE NEW VERSION
1. Check out the latest version from git:
@@ -12,13 +37,13 @@ git clone git://github.com/jjl/get_iplayer.git
git submodule update
-3. Run the run.pl script
-
-perl run.pl <usual get_iplayer args>
+3. Run the main.pl script
+perl main.pl <usual get_iplayer args>
+INSTALLING THE NEW VERSION
-If you do want to install it, you'll need to do these instead:
+If you want to do this, put down the crack pipe, it's not really ready.
1. Check out the latest version from git:
@@ -33,7 +58,4 @@ wget -O - http://cpanmin.us | perl - Mouse MouseX::NativeTraits
3. Copy the script to somewhere easily accessible and make it executable
cp get_iplayer /usr/local/bin/
-chmod 755 /usr/local/bin/get_iplayer
-
-
-Please note these directions are temporary, when the refactoring is done, it'll be much, much easier
+chmod 755 /usr/local/bin/get_iplayer
View
@@ -6,20 +6,14 @@ What the BBC do not cater for are people who use alternative operating systems o
The BBC have a well documented platform neutrality policy which they seem to be reluctant to keep themselves to and after repeated digs at open source, I thought we'd show them what open source can do.
-So get hacking and hold the BBC accountable, because not all licence payers use windows!
-
-PLANS
-
-The code is a bit of a mess at the minute. The first aim is to clean it up and port it to doing things the 'Modern Perl' way.
-
-1. Refactor out the shared variables.
-2. Port all of the classes to Mouse.
-3. Renamespace classes under 'gip::' prefix.
-4. Split it out into seperate files for each class.
-5. Cut back superfluous command line options and more crazy features
-6. Add a new plugin system
-7. Refactor the code to use plugins for some of the 'choices'
-8. Rebundle with App::FatPacker so it's all one script again.
-9. Write tests
-10. Fix bugs
-11. GOTO 8
+So get hacking!
+
+PROMETHEUS
+
+The original get_iplayer code is a mess. I initially began to gradually refactor it but encountered severe problems, largely owing to lexical scoping and variables being shared through scopes.
+
+I gave up and started rewriting it instead. The original script is still there as 'get_iplayer' and i reverted it to the last version that Phil released.
+
+Prometheus is the next generation of get_iplayer. It won't steal fire from the Gods, but it may enable you to use get_iplayer on a non-bbc-supported platform.
+
+Also: http://www.youtube.com/watch?v=-Ryd_p20XEU

0 comments on commit d51a8cd

Please sign in to comment.