=========
NANDCRAFT
=========

Projet de sup à EPITA par :

- Amaury *Chaf*
- Nassim *nass*
- Paul *Dettorer*
- Rémi *halfr*

Objectif
--------
Coder un ordinateur virtuel similaire a celui présenté dans `The Elements of
Computing Systems <http://www1.idc.ac.il/tecs/>`_.

Outils
------

mercurial
~~~~~~~~~
Nous utilisons le gestionnaire de version mercurial.

Pour obtenir le dépot ::

  hg clone https://bitbucket.org/halfr/nandcraft

On utilisera les extensions suivantes :

- ``color``, parce que c'est super kikoo la couleur ;
- ``record``, pour ne commiter que certains changements d'un fichier, plus
  d'infos dans la : `record doc <http://mercurial.selenic.com/wiki/RecordExtension>`_ ;
- ``mq``, cette extension sera utile pour monkey-patcher les fichiers générés
  par org-mode, `mq doc <http://mercurial.selenic.com/wiki/MqExtension>`_.
- ``fetch``, à utiliser en tapant ``hg fetch``, elle combine ``hg pull -u`` et
  ``hg merge`` en une seule commande, très utile, surtout quand on est habitué
  à ce comportement sous git.

Pour activer ces extensions, ajoutez dans votre ``~/.hgrc`` ::

  [extensions]
  color =
  record =
  mq =
  fetch =

Documentation :

- `Pour bien commencer sur bitbucket <http://confluence.atlassian.com/display/BITBUCKET/>`_
- `Mercurial: The Definitive Guide <http://hgbook.red-bean.com/read/>`_

org-mode
~~~~~~~~
Emacs org-mode version 7.7.

**Attention** la version fournie avec emacs 23.3 est la 6.33, il faut donc la
mettre à jour comme indiqué sur : http://orgmode.org/index.html#sec-3

Documentation :

- `Documentation officielle <http://orgmode.org/manual/>`_

org-babel
~~~~~~~~~
org-babel permet d'inclure du code dans un document org-mode.

Pour activer des langages, inclure dans le fichier de configuration emacs
(``~/.emacs.el`` sous \*nix) :

::

  (require 'org-install)

  ;; active Babel languages
  (org-babel-do-load-languages
   'org-babel-load-languages
   '((ocaml . t)))

Documentation :

- `Une introduction suffisament complète`__

__ http://orgmode.org/worg/org-contrib/babel/intro.html