Please read the README file before this one.

STEP 1
------
To detect some capabilities of your system, first type :

  ./configure

Note that you can use the following options :

  --enable-device=<a device>
    Your NTFS device, for example /dev/hda3

  --enable-debug
    To use the debugging capabilities of the kernel module (Only for Linux 2.1)

  --enable-mount-to=<a directory>
    Your mount point for the NTFS partition, for example /nt

  --enable-rw
    To enable write capabilities

STEP 2
------
Then type :

  make

  . For Linux 2.0 this will build the NTFS driver as a Linux kernel module.
  . For Linux 2.1 this will build the NTFS driver as a Linux kernel module.
  . For *BSD this will build the NTFS driver as a Linux kernel module.

  . For all UNIX, this command builds a set of tools to access an NTFS
    partition, too.

  Instead of doing make, you can also invoke 'make patch-kernel' in the linux20
  and linux21 subdirectories. You then need to reconfigure and recompile the
  Linux kernel (see /usr/src/linux/README).

STEP 3 (optional)
------

  make install

  This will place the ntfs utilities into execprefix, and the kernel modules
  into the module directory (currently only on Linux).


STEP 3 (Only for Linux 2.0, Linux 2.1 and *BSD) 
------ 
Now mount a NTFS partition (see mount(8) for details) , 'cd' into it,
'ls' it, and at last try to 'cat' a file such as WINNT35/WIN.INI. If
it works like any other file system, you are done. OTOH, there is a
bug, keep on reading.

If mounting fails, try 'make mount' (provided you told configure what to
mount and where to mount it). This executes the low-level commands needed,
so watch any error messages carefully.

STEP 4
------
Try this, say for example :

  ./ntdir
  ./ntdir WINNT35
  ./ntcat WINNT35/WIN.INI

  If all of this works, you are done. On the contrary, there is a bug, you can
  read the HACKING file to try to track it.
