Permalink
Switch branches/tags
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
65 lines (32 sloc) 3.88 KB

River5 for poets

This is an experiment.

Back when I was a student there was a class called Computer Science for Poets. The idea was that even if you were an English major, programming can make sense, we just have to be careful to define our terms and explain things carefully. I liked the idea then and still like it now.

So I've written a bunch of poets tutorials for things. And here's another!

What is River5?

It's a piece of software that reads lots of RSS feeds and combines their "flows" into a single river that you can then scan to find out what's new. If you were familiar with teletypes, that's kind of what they are like. You just read until you see something you've seen before and then go back to what you were doing. Facebook and Twitter are rivers, btw. We've been doing our rivers since before they existed!

What you need

Your desktop or laptop computer is all you need.

I'm assuming you're using a Mac though the instructions for Windows and Unix are pretty similar.

How to do it

  1. First, download the River5 master folder. You should see a file called river5-master.zip in the Downloads folder.

  2. Right-click on the file in the Finder, and choose Open With... and then first item should be Archive utility. Choose that option. It should create a folder called river5-master.

  3. Rename it to river5, and move it somewhere safe, the desktop, or some other folder.

  4. Open the Terminal app, in the Applications folder. You should see a black icon in the Dock. Drag the river5 folder icon onto the black icon in the Dock. It should open in its own window.

  5. BTW, you're now directly accessing the Unix operating system through something called the command line.

  6. Go to nodejs.org, and download the Mature and Dependable release. When the file downloads, open it, and say yes to all the confirmation prompts.

  7. Now, with Node installed and the River5 folder open in the Terminal app, type this command, followed by Return: npm install

  8. Now you're ready to run River5. Enter this command in the Terminal app: node river5.js

How to create your own river

Okay now you have River5 up and running, but it's only reading the feeds I told it to read. Things get more interesting when you create your own list of feeds.

For this part you need a plain text editor, like Notepad on Windows or TextEdit on the Mac.

  1. FInd the URL of a feed you want to subscribe to and copy it to the clipboard.

  2. Open your text editor and create a new file.

  3. Paste the URL into the text file at the beginning of the file.

  4. For each new URL add it on its own line.

  5. Save the file into the lists folder at the top level of the RIver5 app folder. Call the file myRiver.txt or something else that ends with .txt.

Make sure River5 is running. At the top of the minute it will read the new file, along with all the others in the lists folder, and add it to the feeds it checks.

There will be a new river named myRiver.js in the rivers folder.

When you visit the home page of your site you will see a tab for your river, assuming you haven't customized the tabs on the home page.

There's an example of a .txt list in the lists folder that you downloaded. Here's a screen shot of that file open in my text editor.

Congratulations

That's it! River5 should be doing its thing now, and you can follow the remaining instructions on the home page of this site.