diff options
Diffstat (limited to 'firmware')
-rw-r--r-- | firmware/CONTRIBUTING | 18 | ||||
-rw-r--r-- | firmware/rockbox-mode.el | 22 |
2 files changed, 40 insertions, 0 deletions
diff --git a/firmware/CONTRIBUTING b/firmware/CONTRIBUTING new file mode 100644 index 0000000000..b38409ade5 --- /dev/null +++ b/firmware/CONTRIBUTING | |||
@@ -0,0 +1,18 @@ | |||
1 | $Id$ | ||
2 | |||
3 | In order for the project to run as smoothly as possible, it's best if all | ||
4 | contributors adhere to a few simple conventions: | ||
5 | |||
6 | - Write all code in C. Sometimes assembly is faster, but C is always more | ||
7 | readable and maintainable. | ||
8 | |||
9 | - Write C code. Don't redefine the language. No new types, no C++isms or | ||
10 | Javaisms. | ||
11 | |||
12 | - Variables and function names should be all lower case. | ||
13 | Preprocessor symbols should be all uppercase. | ||
14 | |||
15 | - Use the brace placement style of your choice, but indent your code with | ||
16 | four spaces. Don't use TAB characters, as that will mess up code display in | ||
17 | CVS, printing, and a zillion other places. | ||
18 | |||
diff --git a/firmware/rockbox-mode.el b/firmware/rockbox-mode.el new file mode 100644 index 0000000000..5ede3b4c20 --- /dev/null +++ b/firmware/rockbox-mode.el | |||
@@ -0,0 +1,22 @@ | |||
1 | ;;;; Emacs Lisp help for writing rockbox code. ;;;; | ||
2 | ;;;; $Id$ | ||
3 | |||
4 | ;;; In C files, put something like this to load this file automatically: | ||
5 | ;; | ||
6 | ;; /* ----------------------------------------------------------------- | ||
7 | ;; * local variables: | ||
8 | ;; * eval: (load-file "../curl-mode.el") | ||
9 | ;; * end: | ||
10 | ;; */ | ||
11 | ;; | ||
12 | ;; (note: make sure to get the path right in the argument to load-file). | ||
13 | |||
14 | |||
15 | ;;; The rockbox hacker's C conventions | ||
16 | |||
17 | ;;; we use intent-level 2 | ||
18 | (setq c-basic-offset 4) | ||
19 | ;;; never ever use tabs to indent! | ||
20 | (setq indent-tabs-mode nil) | ||
21 | ;;; I like this, stolen from Subversion! ;-) | ||
22 | (setq angry-mob-with-torches-and-pitchforks t) | ||