# HG changeset patch
# User Louis Opter <louis@lse.epitech.net>
# Date 1325981399 -3600
# Node ID 29c22fa5ec20edf24c765a0992a08b0a0f2c5d12
# Parent  c7c59cebab85df113ffcf5fc869c43258888c1ef
Start to work on the "First Steps" guide again

diff -r c7c59cebab85 -r 29c22fa5ec20 doc_improve_first_steps.patch
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc_improve_first_steps.patch	Sun Jan 08 01:09:59 2012 +0100
@@ -0,0 +1,60 @@
+# HG changeset patch
+# Parent ae716670f1ff537fa8abe61d8bd82b6c5f91a5e2
+doc: vastly improve the "First Steps" documentation to reflect all the recent improvements
+
+diff --git a/doc/rathaxes/user/firststeps_en.tex b/doc/rathaxes/user/firststeps_en.tex
+--- a/doc/rathaxes/user/firststeps_en.tex
++++ b/doc/rathaxes/user/firststeps_en.tex
+@@ -31,6 +31,8 @@
+ 0.3 & 04/09/2011 & David Pineau & Quick fixes \\
+ \hline
+ 0.4 & 07/19/2011 & Louis Opter & Add on overview of the generation of a driver \\
++\hline
++0.5 & 01/08/2012 & Louis Opter & Update to cover the latest improvements \\
+ }
+ 
+ \begin{document}
+@@ -39,7 +41,7 @@
+ 
+ \begin{abstract}
+ \rtx\ is a Domain Specific Language to describes peripherals drivers. It
+-compiles to kernel modules written in C for Linux, Windows and OpenBSD.
++compiles to kernel modules written in C for any defined Operating System.
+ 
+ This document explains how to setup the \rtx\ compiler on Windows and Unix like
+ platforms and generate your first peripheral driver.
+@@ -59,9 +61,21 @@
+ develop on \rtx\ itself from Windows you can also choose to install \rtx\ from
+ the sources (i.e. without the installer).
+ 
+-Although \rtx\ only generate drivers for Windows, Linux and OpenBSD it can be
+-installed and used from others operating systems as well (including other BSDs
+-and MacOS~X).
++\rtx\ doesn't need to be installed on the target operating system for driver
++generation. In other words, you can install \rtx\ on Windows and generate the
++sources of a Linux driver (from Windows).
++
++If you intend to write Windows drivers with \rtx\ you will also need to install
++the Microsoft Driver Development Kit.
++
++If you intend to build the driver source code generated by \rtx\ you will also
++need to install the required compiler tool-chain to build them. On Windows that
++would be the Microsoft Driver Development Kit; on Linux that would be the Linux
++sources and the GCC tool-chain.
++
++Finally, we made it very easy to build \rtx\ source files from a CMake
++``Makefile'', so you are highly encouraged to install \href{http://www.cmake.org/}{CMake}
++along with \rtx. CMake works on all the operating systems supported by \rtx.
+ 
+ \subsection{Using the Windows installer}
+ 
+@@ -71,9 +85,6 @@
+ Download the \href{http://rathaxes.googlecode.com/files/rathaxes-latest.exe}{installer},
+ then simply execute it and follow the instructions on your screen.
+ 
+-To build and use the drivers generated by \rtx\ you will also need the
+-Microsoft Driver Development Kit.
+-
+ \subsection{From the sources on Unix}
+ 
+ If you are not on Windows you will have to install \rtx\ from a ``source
diff -r c7c59cebab85 -r 29c22fa5ec20 series
--- a/series	Sat Jan 07 23:56:11 2012 +0100
+++ b/series	Sun Jan 08 01:09:59 2012 +0100
@@ -1,3 +1,4 @@
+doc_improve_first_steps.patch
 provided_pointcut_in_required_sequences_fail.patch
 rathaxes_add_a_linux_lkm.patch
 rathaxes_start_to_implement_pci_stuff_in_the_lkm.patch