Mercurial > archived > louis > epitech > mq > rathaxes
comparison doc_improve_first_steps.patch @ 35:29c22fa5ec20
Start to work on the "First Steps" guide again
| author | Louis Opter <louis@lse.epitech.net> |
|---|---|
| date | Sun, 08 Jan 2012 01:09:59 +0100 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 32:c7c59cebab85 | 35:29c22fa5ec20 |
|---|---|
| 1 # HG changeset patch | |
| 2 # Parent ae716670f1ff537fa8abe61d8bd82b6c5f91a5e2 | |
| 3 doc: vastly improve the "First Steps" documentation to reflect all the recent improvements | |
| 4 | |
| 5 diff --git a/doc/rathaxes/user/firststeps_en.tex b/doc/rathaxes/user/firststeps_en.tex | |
| 6 --- a/doc/rathaxes/user/firststeps_en.tex | |
| 7 +++ b/doc/rathaxes/user/firststeps_en.tex | |
| 8 @@ -31,6 +31,8 @@ | |
| 9 0.3 & 04/09/2011 & David Pineau & Quick fixes \\ | |
| 10 \hline | |
| 11 0.4 & 07/19/2011 & Louis Opter & Add on overview of the generation of a driver \\ | |
| 12 +\hline | |
| 13 +0.5 & 01/08/2012 & Louis Opter & Update to cover the latest improvements \\ | |
| 14 } | |
| 15 | |
| 16 \begin{document} | |
| 17 @@ -39,7 +41,7 @@ | |
| 18 | |
| 19 \begin{abstract} | |
| 20 \rtx\ is a Domain Specific Language to describes peripherals drivers. It | |
| 21 -compiles to kernel modules written in C for Linux, Windows and OpenBSD. | |
| 22 +compiles to kernel modules written in C for any defined Operating System. | |
| 23 | |
| 24 This document explains how to setup the \rtx\ compiler on Windows and Unix like | |
| 25 platforms and generate your first peripheral driver. | |
| 26 @@ -59,9 +61,21 @@ | |
| 27 develop on \rtx\ itself from Windows you can also choose to install \rtx\ from | |
| 28 the sources (i.e. without the installer). | |
| 29 | |
| 30 -Although \rtx\ only generate drivers for Windows, Linux and OpenBSD it can be | |
| 31 -installed and used from others operating systems as well (including other BSDs | |
| 32 -and MacOS~X). | |
| 33 +\rtx\ doesn't need to be installed on the target operating system for driver | |
| 34 +generation. In other words, you can install \rtx\ on Windows and generate the | |
| 35 +sources of a Linux driver (from Windows). | |
| 36 + | |
| 37 +If you intend to write Windows drivers with \rtx\ you will also need to install | |
| 38 +the Microsoft Driver Development Kit. | |
| 39 + | |
| 40 +If you intend to build the driver source code generated by \rtx\ you will also | |
| 41 +need to install the required compiler tool-chain to build them. On Windows that | |
| 42 +would be the Microsoft Driver Development Kit; on Linux that would be the Linux | |
| 43 +sources and the GCC tool-chain. | |
| 44 + | |
| 45 +Finally, we made it very easy to build \rtx\ source files from a CMake | |
| 46 +``Makefile'', so you are highly encouraged to install \href{http://www.cmake.org/}{CMake} | |
| 47 +along with \rtx. CMake works on all the operating systems supported by \rtx. | |
| 48 | |
| 49 \subsection{Using the Windows installer} | |
| 50 | |
| 51 @@ -71,9 +85,6 @@ | |
| 52 Download the \href{http://rathaxes.googlecode.com/files/rathaxes-latest.exe}{installer}, | |
| 53 then simply execute it and follow the instructions on your screen. | |
| 54 | |
| 55 -To build and use the drivers generated by \rtx\ you will also need the | |
| 56 -Microsoft Driver Development Kit. | |
| 57 - | |
| 58 \subsection{From the sources on Unix} | |
| 59 | |
| 60 If you are not on Windows you will have to install \rtx\ from a ``source |