Skip to content

Instantly share code, notes, and snippets.

@flyser
Created June 12, 2012 09:31
Show Gist options
  • Save flyser/2916476 to your computer and use it in GitHub Desktop.
Save flyser/2916476 to your computer and use it in GitHub Desktop.

Cournal is a collaborative note taking and journal application using a stylus.

Why?

I need something to allow collaborative annotation of PDF files, Cournal is therefore heavily inspired by Xournal (note taking) and Gobby (collaboration).

Aim

The goal of this project is a note taking application similar to Xournal, but with networking support.

Why not extend Xournal?

There has been numerous discussions over many years on the Xournal mailing list and Xournal++ even had experimental networking support, but it didn't work out. So I started Cournal, which got networking support just after PDF viewing and simple drawing was done and was therefore designed with networking in mind from the ground up.

Does it work yet

Yes, but you might miss some features (to change that, see next section ;-)).

How to help

You are very welcome to support the project!

To get into Cournal hacking, have a look at LINKS.md, which contains a list of most things you need to know. Feel free to contact me, if questions arise or if you want to improve Cournal, but don't know what needs work.

Dependencies

  • Python 3.x
  • Poppler 0.18 or newer
  • GObject Introspection
  • ZopeInterface 3.6.0 or newer
  • GTK+ 3.x
  • Twisted for python3 (download script: download-twisted.sh)

Installation

A proper installation is unsupported at the moment. To start Cournal run ./download-twisted.sh in Cournals base directory

Patches to support system-wide installation are very welcome.

Usage

Server
cournal-server.py [portnumber]
Client

Start Cournal, select "Annotate PDF" and then "Connect to Server".

File Format

The file format is compatible to Xournals .xoj files, but Cournal might not be able to open some .xoj files created by Xournal, because the it doesn't support all features of the file format. The other way around should work though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment