index.org

   1 #+TITLE:    ELBB - Emacs-Lisp Bill-Board
   2 #+STARTUP:  even hidestars unfold
   3 #+AUTHOR:   Emacs Community
   4 #+EMAIL:    bzg AT gnu DOT org
   5 #+LANGUAGE: en
   6 #+OPTIONS:  skip:nil toc:nil
   7
   8 * Welcome to the Emacs Lisp Bill Board
   9
  10 ELBB lets Emacs users and developers share snippets of [[file:code/][code/]].
  11
  12 ELBB is a [[http://repo.or.cz/w/elbb.git][git repository]] of Emacs-Lisp snippets of code, both as =.el=
  13 files and as examples of code within =org-mode= pages.
  14
  15 # It also meant to be a place of discussions, exchange of experiences,
  16 # mini-howto's.
  17 # Better tell how it works instead of what it is.
  18
  19 # Backed by Git as versions-control-system, it should
  20 # be possible to tailor useful information.
  21
  22 # Dealing with snippets reduces complexity, ELBB might be
  23 # useful as a resource for Emacs Lisp beginners as for
  24 # developers --examining certain topics-- as well.
  25 #
  26 # ELBB is thought to collect knowledge from (SX)Emacs
  27 # mailing lists, thus providing structured access.
  28
  29 * Contributing to ELBB
  30
  31 Emacs users are encouraged to upload their Emacs Lisp code and/or to
  32 modify existing code.
  33
  34 # ELBB will always stay somehow experimental, a playing ground even for
  35 # the use of Git. Nonetheless its recommended rather to commit own
  36 # variants than reverting the code of others
  37 # - unless it seems urgent otherwise... :)
  38
  39 The repository is here: http://repo.or.cz/w/elbb.git
  40
  41 It contains:
  42
  43 - =.org= pages (such as this one)
  44 - =.el= files in the [[file:code/][code/]] directory
  45 - snippets of code within =.org= pages
  46
  47 This website is produced by exporting the =.org= pages to HTML.
  48
  49 ** How to contribute?
  50
  51    1. create an account on [[http://repo.or.cz/m/reguser.cgi][repo.or.cz]]
  52
  53    2. send [[mailto:bzg%20AT%20gnu%20DOT%20org][me]] your username
  54
  55    3. clone ELBB with =git clone ssh://repo.or.cz/srv/git/elbb.git=
  56
  57    4. make some changes
  58
  59    5. commit your changes like this: =git commit -a=, then enter a
  60       message describing your change
  61
  62    6. push your changes with =git push=
  63
  64    7. Please make sure pushing only code compatible
  65       with GPL.  Indicate authorship - and source in case
  66       of third party snippets.
  67
  68 ** Getting Started
  69
  70 Here is an [[file:elbb-example-page.org][example of page]] with code.
  71
  72 Here another one [[file:elbb.org][elbb itself]].
  73
  74 * History
  75
  76 Andreas Roehler had this [[http://news.gmane.org/group/gmane.emacs.xemacs.beta/thread%3D29327/force_load%3Dt][idea of an Emacs Lisp Bill Board]], Daniel
  77 Clemente suggested to make something similar to [[http://orgmode.org/worg/][the Worg project]], and
  78 here it is.