General Information
===================

lapiz is a small and lightweight UTF-8 text editor for the CAFE
environment. Based on gedit, the text editor for the GNOME2 environment.

lapiz is part of CAFE and uses the latest CTK+ and CAFE libraries.
Complete CAFE integration is featured, with support for Drag and Drop (DnD)
from Baul (the CAFE file manager), the use of the CAFE help system,
the CAFE Virtual File System and the CAFE print framework.

lapiz uses a Multiple Document Interface (MDI), which lets you edit more than
one document at the same time.

lapiz supports most standard editing features, plus several not found in your
average text editor (plugins being the most notable of these).

Although new features are always under development, currently lapiz has:

    * Complete support for UTF-8 text
    * Syntax highlighting
    * Support for editing remote files
    * Search and Replace
    * Printing and Print Previewing Support
    * File Revert
    * A complete preferences interface
    * Configurable Plugin system


Some of the plugins, packaged and installed with lapiz include, among others:

    * Word count
    * Spell checker
    * Change case of selected text
    * File Browser
    * Sort
    * Insert Date/Time
    * Tag list

Other external plugins are also available.


lapiz is released under the GNU General Public License (GPL) version 2, see
the file 'COPYING' for more information.


The official web site is:

    https://cafe-desktop.org/

You can download the latest lapiz tarball from:

    https://pub.cafe-desktop.org/releases/

Installation
============

lapiz requires CTK+-3.14.x and CtkSourceView 3.0.x.

Simple install procedure:

  % ./autogen.sh				# run the `configure' script
  % make					# build lapiz
  [ Become root if necessary ]
  % make install				# install lapiz


Running Tests
==================
Lapiz has several test that can be run after compilation. Run them by issueing "make check". However there are a couple of requirements that need to be satisfied before they will pass.

* You need the gsettings schemas installed for some tests to be able to run.
* You need to mount sftp://localhost/ with gvfs-mount for one test to pass.

If test fail and you have setup the above correctly then please file a bug report as described below.

How to report bugs
==================

Bugs should be reported to the CAFE bug tracking system:

  https://github.com/cafe-desktop/lapiz/issues 
  
You will need to create an account for yourself.

In the bug report please include:

* Information about your system. For instance:

   - What operating system and version
   - What version of X
   - What version of the ctk+, glib and cafe libraries
   - For Linux, what version of the C library

  And anything else you think is relevant.

* How to reproduce the bug.

* If the bug was a crash, the exact text that was printed out when the
  crash occurred.

* Further information such as stack traces may be useful, but is not
  necessary. If you do send a stack trace, and the error is an X error,
  it will be more useful if the stack trace is produced running the test
  program with the --sync command line option.


Patches
=======

Patches should also be submitted to https://github.com/cafe-desktop/lapiz,
preferably via pull requests.


  The lapiz team.