Mercurial > archived > louis > epitech > mq > rathaxes

annotate doc_improve_first_steps.patch @ 35:29c22fa5ec20

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