aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com>2017-10-06 08:10:43 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-10-07 23:20:25 +0100
commit28249c42701f9156a0b3153d72d7e46dacab37cb (patch)
treefd543f088d9358d07bbe9447ae320f01562b121e
parent6775e2de9067d8f472d7bfb5b78ec835a5688755 (diff)
downloadbitbake-28249c42701f9156a0b3153d72d7e46dacab37cb.tar.gz
bitbake-28249c42701f9156a0b3153d72d7e46dacab37cb.tar.bz2
bitbake-28249c42701f9156a0b3153d72d7e46dacab37cb.zip
README: new readme file including main aspects of the project
Includes brief description of the project, pointers to website, documentation, mailing list and source code. Signed-off-by: Leonardo Sandoval <leonardo.sandoval.gonzalez@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--README35
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..479c3765
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+Bitbake
+=======
+
+BitBake is a generic task execution engine that allows shell and Python tasks to be run
+efficiently and in parallel while working within complex inter-task dependency constraints.
+One of BitBake's main users, OpenEmbedded, takes this core and builds embedded Linux software
+stacks using a task-oriented approach.
+
+For information about Bitbake, see the OpenEmbedded website:
+ http://www.openembedded.org/
+
+Bitbake plain documentation can be found under the doc directory or its integrated
+html version at the Yocto Project website:
+ http://yoctoproject.org/documentation
+
+Contributing
+------------
+
+Please refer to
+http://www.openembedded.org/wiki/How_to_submit_a_patch_to_OpenEmbedded
+for guidelines on how to submit patches, just note that the latter documentation is intended
+for OpenEmbedded (and its core) not bitbake patches (bitbake-devel@lists.openembedded.org)
+but in general main guidelines apply. Once the commit(s) have been created, the way to send
+the patch is through git-send-email. For example, to send the last commit (HEAD) on current
+branch, type:
+
+ git send-email -M -1 --to bitbake-devel@lists.openembedded.org
+
+Mailing list:
+
+ http://lists.openembedded.org/mailman/listinfo/bitbake-devel
+
+Source code:
+
+ http://git.openembedded.org/bitbake/