[meta-freescale] [Documentation][PATCH 1/3] README: Reorganize how-to-build instructions
Daiane Angolini
daiane.angolini at freescale.com
Tue Sep 29 10:35:42 PDT 2015
The instructions on how to build were placed in README file only for Release
Notes sub-project, however it is applicable for all other projects as well.
Signed-off-by: Daiane Angolini <daiane.angolini at freescale.com>
---
README | 26 ++++++++++++++++++++++++++
release-notes/README | 24 ------------------------
2 files changed, 26 insertions(+), 24 deletions(-)
diff --git a/README b/README
index 8b2c71e..e903208 100644
--- a/README
+++ b/README
@@ -10,6 +10,32 @@ install it in Debian/Ubuntu, please do:
Once this has been completed, you can run 'make' in each of the Documentation
folders to review the available targets for building.
+How to generate the binary
+--------------------------
+
+Follow the instructions below inside each sub-project in order to generate the
+desired binary.
+
+In order to generate the HTML all-in-one:
+
+ $ make singlehtml
+
+In order to generate the PDF file:
+
+ $ make latexpdf
+
+Make sure you have the packages listed in ../README file to get
+PDF built.
+
+In order to generate the printable PDF file:
+
+ $ make latexpdf -t <option>
+
+Where option can be:
+
+ * a4twoside = A4 page size and two side print;
+ * lettertwoside = letter page size and two side print;
+ * the default value is letter page size and one side print;
Contributing
------------
diff --git a/release-notes/README b/release-notes/README
index 21d23d7..e1b7c9e 100644
--- a/release-notes/README
+++ b/release-notes/README
@@ -1,27 +1,3 @@
-Usage
------
-
-In order to generate the HTML all-in-one:
-
- $ make singlehtml
-
-In order to generate the PDF file:
-
- $ make latexpdf
-
-Make sure you have the packages listed in ../README file to get
-PDF built.
-
-In order to generate the printable PDF file:
-
- $ make latexpdf -t <option>
-
-Where option can be:
-
- * a4twoside = A4 page size and two side print;
- * lettertwoside = letter page size and two side print;
- * the default value is letter page size and one side print;
-
Data generation
--------------
The data used by the Release Notes document is partially generated by
--
1.9.1
More information about the meta-freescale
mailing list