Skip to content

A more extensive and updated project intro in the README #12

Open
@consideRatio

Description

@consideRatio

I'd love to use and contribute with maintenance of this project, but I struggle to understand enough about it to feel confident on how to install it etc.

Here are some points that i think could be addressed within the README:

  • TightVNC is mentioned, but it is TigerVNC that is vendored in (a fork of TightVNC).
  • websockify is a required dependency, but that is not documented
    • pip install of websockify doesn't seem to cut it, but conda install -c conda-forge does. Perhaps that is why it is not listed under install_requires in setup.py?
  • __init__.py points to share/xstartup, which in turn does exec /usr/bin/dbus-launch xfce4-session, making me think that the apt packages dbus-x11 and xfce4-session are strictly required.
  • What apt packages are required?
    As xfce4-session is required, perhaps is xorg (x11?) and other xfce4 packages strictly required as well?
  • A "how it works" section like in jupyterhub-idle-culler's README
    Having an explanations of how it works technically could help me a lot to use and contribute to this project!
  • Is the Dockerfile supposed to be used for binderhub, or is it a published artifact?
  • Is the Python package published?
    If it is or should be, we should use a badge
    If it is not, why isn't it published and should it be soon?
  • What is supposed to be exposed via the /panel path?
    image

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions