search

GNOME-MouseTrap / mousetrap

Developer site for GNOME's MouseTrap
https://wiki.gnome.org/Projects/MouseTrap
GNU General Public License v2.0
4 stars 12 forks source link

Add depedency help in README.md #45

Open StoneyJackson opened 10 years ago

StoneyJackson commented 10 years ago 
[10:14am] heidie: I've got some nine CS students who are newbies that need to get the system up and running.
[10:14am] kevin-brown: #info I am planning on getting a Windows environment set up to test out the pull request and fix the translations
[10:15am] stoney: #info i personally have no plans to work on this this semester, unless I find some free time
[10:15am] heidie: They will have already read the MouseTrap and github sites as part of an assignment, but I think that there aren't download and install instructions in one place.
[10:15am] heidie: Am I wrong? Is there such an animal?
[10:15am] kevin-brown: https://github.com/GNOME-MouseTrap/mousetrap#download and https://github.com/GNOME-MouseTrap/mousetrap#installing may be useful 
[10:16am] stoney: right ^ in the READM.md
[10:16am] heidie: Yes, helpful, but these don't list any dependencies such as OpenCV.
[10:16am] heidie: Right.
[10:16am] heidie: But I think that there are some other dependencies lurking.
[10:16am] stoney: the README lists dependencies but not how to install
[10:16am] kevin-brown: Right, OpenCV depends on the system
[10:16am] stoney: (install the dependencies)
[10:17am] stoney: but I think that is normal
[10:17am] heidie: Ah, OK.
[10:17am] heidie: Right.
[10:17am] stoney: that is, you don’t tend to describe how to install dependencies
[10:17am] kevin-brown: PyYAML and python-xlib should be installed through pip
[10:18am] stoney: Maybe we could/should add a section to the README.md that give a simple example of how to install dependencies...
[10:18am] heidie: Ah, that would be helpful for newbies.
[10:18am] stoney: but wouldn’t be the definitive guide
[10:19am] stoney: at least pointers like… “use pip for PyYAML”
[10:19am] kevin-brown: We are also missing the gobject dependencies (not sure what the name actually is)
[10:20am] heidie: Yes, right. I don't want to make the quintessential mistake of FOSS projects which is to not provide a clear onramp for newbies.

https://wiki.gnome.org/Projects/PyGObject

StoneyJackson commented 10 years ago

We have something like this on our wiki. I'm not sure if it is up-to-date. Even if it is, I would rather this documentation be in the codebase (like README) and the wiki page delete.

https://github.com/GNOME-MouseTrap/mousetrap/wiki/Getting-Started