README

   1 Welcome to YAFFS, the first file system developed specifically for NAND flash.
   2
   3 Before you go too far, you might consider looking at YAFFS2.
   4
   5 A note on licencing
   6 -------------------
   7 YAFFS is available under GPL and via alternative licensing arrangements with
   8 Alpeh One. Generally, if you're using YAFFS as a Linux kernel file system
   9 you can use the GPL and in other cases you need to discuss licensing issues
  10 with Aleph One.
  11
  12
  13 Where do you want to go today?
  14 ------------------------------
  15 direct       This is the userspace/RTOS variant of YAFFS. This is used for yaffs
  16              core development and for embedding YAFFS in products that don't use
  17              Linux or WinCE
  18 linux-module This allows you to build YAFFS as a free-standing Linux kernel
  19              module. By "free standing", I mean that this build happens
  20              outside the kernel tree. Generally you'd use this for testing.
  21 linux-kernel This allows you to hook YAFFS into the kernel tree, to build
  22              YAFFS within the kernel tree.
  23 utils        These are some utilities for Linux.
  24 wince        Windows CE support. Horribly dated. Contact Aleph One is you're
  25              considering YAFFS for a WinCE project.
  26 mtdemul      An mtd NAND emulation driver for testing YAFFS under Linux.
  27 Documentation Some YAFFS documents. Also visit www.aleph1.co.uk.
  28