================================== tux3 ReadMe =================================

Tux3 is a write-anywhere, atomic commit, btree-based versioning filesystem.
It is the spiritual and moral successor of Tux2, the most famous filesystem that
was never released. The main purpose of Tux3 is to embody Daniel Phillips's new
ideas on storage data versioning. The secondary goal is to provide a more
efficient snapshotting and replication method for the Zumastor NAS project,
and a tertiary goal is to be better than ZFS.

This package contains the userspace (fuse) ,kernelspace (module) and tools for
tux3 versioned filesystem.

    * The latest version of this module can be obtained from anonymous hg with 
      this command:

        hg clone http://hg.tux3.org/tux3/

    * Packaged releases can be found from:

        http://tux3.org/downloads/

    * More documentation is available at 

        http://tux3.org/

    * Finally, you can subscribe to the development mailing list at

	http://mailman.tux3.org/cgi-bin/mailman/listinfo/tux3

1. Status

    * Tux3 is currently under heavy development (see hg and git commit logs).

2. howto use

    * make a tux3 filesystem in a file
	# dd if=/dev/zero of=testdev bs=1M count=1
	# tux3 mkfs testdev
	# mkdir testdir
	if you want tu use tux3 userspace
	# tux3fuse testdev testdir
	or the kernel module
	# mount -t tux3 -o loop testdev testdir

Happy hacking.