docs/manual: mention the Eclipse integration
authorThomas Petazzoni <thomas.petazzoni@free-electrons.com>
Sun, 13 Jan 2013 04:52:14 +0000 (04:52 +0000)
committerPeter Korsgaard <jacmet@sunsite.dk>
Mon, 14 Jan 2013 15:33:33 +0000 (16:33 +0100)
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@free-electrons.com>
Signed-off-by: Peter Korsgaard <jacmet@sunsite.dk>
docs/manual/eclipse-integration.txt [new file with mode: 0644]
docs/manual/working-with.txt

diff --git a/docs/manual/eclipse-integration.txt b/docs/manual/eclipse-integration.txt
new file mode 100644 (file)
index 0000000..3d8179f
--- /dev/null
@@ -0,0 +1,30 @@
+// -*- mode:doc; -*-
+
+Integration with Eclipse
+------------------------
+
+While a part of the embedded Linux developers like classical text
+editors like Vim or Emacs, and command-line based interfaces, a number
+of other embedded Linux developers like richer graphical interfaces to
+do their development work. Eclipse being one of the most popular
+Integrated Development Environment, Buildroot integrates with Eclipse
+in order to ease the development work of Eclipse users.
+
+Our integration with Eclipse simplifies the compilation, remote
+execution and remote debugging of applications and libraries that are
+built on top of a Buildroot system. It does not integrate the
+Buildroot configuration and build processes themselves with
+Eclipse. Therefore, the typical usage model of our Eclipse integration
+would be:
+
+* Configure your Buildroot system with +make menuconfig+, +make
+  xconfig+ or any other configuration interface provided with
+  Buildroot.
+* Build your Buildroot system by running +make+.
+* Start Eclipse to develop, execute and debug your own custom
+  applications and libraries, that will rely on the libraries built
+  and installed by Buildroot.
+
+The Buildroot Eclipse integration installation process and usage is
+described in detail at
+https://github.com/mbats/eclipse-buildroot-bundle/wiki.
index b62bacdcbf4e9810338ee397ffe98c8064f51b57..fb6bc40e3b2be503e0b5917f10328dae74f0bec7 100644 (file)
@@ -14,6 +14,8 @@ include::customize.txt[]
 
 include::common-usage.txt[]
 
+include::eclipse-integration.txt[]
+
 Hacking Buildroot
 -----------------