summaryrefslogtreecommitdiff
path: root/doc/README.dev
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.dev')
-rw-r--r--doc/README.dev20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/README.dev b/doc/README.dev
new file mode 100644
index 0000000000..ae28bc03be
--- /dev/null
+++ b/doc/README.dev
@@ -0,0 +1,20 @@
+1) API
+------
+
+* libavcodec is the library containing the codecs (both encoding and
+ decoding). See libavcodec/apiexample.c to see how to use it.
+
+* libav is the library containing the file formats handling (mux and
+ demux code for several formats). (no example yet, the API is likely
+ to evolve).
+
+2) Coding Rules
+---------------
+
+ffmpeg is programmed in ANSI C language. GCC extension are
+tolerated. TAB size is 4. The identation is the one specified by
+'indent -i4 -kr'.
+
+Main priority in ffmpeg is simplicity and small code size (=less
+bugs).
+