Readme should be explicit about prerequisites, functionality

Bug #244216 reported by Brianna Laugher
2
Affects Status Importance Assigned to Milestone
RescueTime Linux Uploader
New
Undecided
Unassigned

Bug Description

Prereqs: namely, bzr (well python too, but that is pretty common)
Maybe a note about the setup-utils egg thing that Python grabs if you don't have it yet

The readme says for Firefox: "Open the firefox_extension/rescuetime_exporter.xpi" It neglects to mention that you need to run 'chmod +x build.sh' and then run build.sh to create that file.

Functionality: I feel a bit dumb to ask this, but after running 'rescuetime_linux_uploader' in a terminal, do I need to keep this terminal open the whole time? Do I need to open it again every time I use my computer for RescueTime to work? (or equally set it up to auto-run)

One of these things would be good to mention in the readme.

Revision history for this message
Casey Watson (watsoncj+launchpad) wrote :

These are great questions.

Of course "sh build.sh" will do the trick as well, but it would be useful to mention it.

It appears that you can safely skip the step of running the rescuetime_linux_uploader script and go straight to adding the applets to the gnome panel. The applet will prompt you for your login info.

I also have a question about the domainwhitelist.txt file. Is this really what it sounds like? Will the uploader only report on usage from these sites?

A bit more documentation would be helpful. The app is looking great, and is working very well for me. Keep up the good work!

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.