Skip to content

aarmea/ThreeRing

Repository files navigation

ThreeRing

ThreeRing aims to be an open-source (GPL v3) cross-platform note-taking application that uses HTML, SVG, and similar web technologies as the native file format so that notes can be read in any standards-compliant browser.

State of ThreeRing

ThreeRing is very early in development, and many of its planned features have not yet been implemented.

What works

  1. Drawing and erasing ink with the pen and eraser of a Wacom tablet.
  2. Saving and opening notes to and from SVG files.
  3. A lasso tool (with the Shift key) to select a free-form area of ink.
  4. A move tool (active when there is selected ink) that can move and delete ink.

What doesn't

  1. Undo and redo.
  2. Text boxes and other note types.
  3. Support for mobile platforms (iOS, Android).

Building from source

ThreeRing is a standard Qt 4.7.x/4.8.x application with no external dependencies and has been tested on Windows, Mac OS X, and Linux.

Setup

  1. Install a C++ compiler, such as GCC (on Linux), Clang (on Mac OS X), or Microsoft Visual C++ 2010 (on Windows).
  2. Install the Qt 4.8.x libraries for your platform.
    • Mac OS X note: Qt tablet support is broken in the 4.8.x line. Install the 4.7.x libraries instead.
  3. (Optional) Install Qt Creator.

Compiling

From the command line

  1. Clone ThreeRing into a directory.

  2. On Windows, open a Qt 4.8 Command Prompt and do the following:

     cd [cloned-threering]
     qmake
     nmake
    
  3. On Linux, open a shell and do the following:

     cd [cloned-threering]
     qmake
     make
    
  4. On Mac, open a shell and do the following:

     cd [cloned-threering]
     qmake -spec macx-g++
     make
    

For release mode, replace make with make release. You may need to copy some Qt shared libraries from their install directories to the ThreeRing directory for it to run.

With Qt Creator

  1. Open ThreeRing.pro in Qt Creator.
  2. Click Run (or press Ctrl+R).

Copyright

© 2013 Albert Armea

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

About

An open-source, cross-platform note-taking application.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published