README

picotm Demo


About picotm-demo
=================

  Picotm-demo is a demo application for picotm.


Downloads and Contact
=====================

  Picotm-demo is part of the picotm transaction manager available at the
  project's website at

    http://picotm.org

  The GitHub repository is available at

    http://github.com/picotm/picotm-demo


Requirements
============

  Picotm-demo is written in C and requires

    - a recent gcc compiler + environment, such as gcc 4.8 or later,
    - picotm 0.9 or later,
    - ncurses.

  The build scripts depend on

    - GNU autotools (autoconf and automake),
    - GNU autoconf archive,
    - GNU libtool,
    - GNU make, and
    - a recent Linux (for running the build scripts).

  All source code is held in a git repository, so you'll need

    - git

  for development.


Building picotm-demo
====================

  Make sure you have all requirements installed. To prepare your build,
  invoke

    tools/bootstrap.sh

  This command generates the build system based on GNU autotools. If it
  succeeds without errors, invoke

    ./configure
    make

  This should configure and build picotm-demo for your system. Install with

    sudo make install

  You can find more detailed install instructions in the file INSTALL
  that comes with this package.


Running picotm-demo
===================

  After bulding and installing picotm-demo invoke

    picotm-demo

  from the command line. Press <ctrl-c> to exit the program.


License
=======

  Picotm-demo 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 <https://www.gnu.org/licenses/>.