Initial Commit - Adding README.md

Change-Id: I847035cec309681f506d78cf593965603f50eb44

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..efed962
--- /dev/null
+++ b/README.md
@@ -0,0 +1,84 @@
+# tbb
+Tizen Building Block Tool
+
+TBB is a tool to make Tizen IoT Image easily.
+
+It uses the kernel config tool(kconfig).
+
+You can select some configurations and make a Tizen IoT Image according to your need.
+
+It is verified on Ubuntu 14.04(LTS).
+
+# How to select configurations
+1. Platform Version (Can use the default)
+- You can select 4.0 or 5.0.
+
+2. Snapshot ID (Can use the default)
+- Tizen repo snapshot id. Its format is yyyymmdd.n.
+- You can check it on http://download.tizen.org/snapshots/tizen/4.0-unified/ or http://download.tizen.org/snapshots/tizen/unified/.
+
+3. Image Name (Can use the default)
+- You can change the prefix of output image name.
+
+4. Select Board
+- You must select a board. (Currently ARTIK530, RPI3 are supported)
+- You can see next menu when selecting a board.
+
+5. HW & HAL Features
+- You should select some HW and HAL feautres which you add to a device.
+
+6. Select Partition
+- You must select a partition.
+- You can see next menu when selecting a partition.
+
+7. Tizen IoT Preset
+- You should select a Tizen IoT Preset.
+- If you are a export, you can select no preset and packages directly in "Advanced Configuration" menu.
+- There are two presets. (Tizne IoT Core and Tizen IoT Headed). You can see Tizen IoT Headed preset only when selecting Display Server in "HW & HAL Features" menu.
+- You can see next menu when selecting a preset.
+
+8. Tizen Native API Sets
+- You should select API which you add to a device.
+
+Optionally
+
+9. Tizen Platform Internal Feature Sets
+
+10. Tizen IoT Reference Application
+
+11. Advanced Configuration
+- You can select some individual packages.
+
+12. Custom repository for your rpm packages.
+Adding your repository to private repository menu if needed.
+- local repo   - file:///directory
+- http(s) repo - http://URL or https://URL
+
+# Prerequisites
+libncurses5-dev, mic, libxml2-utils(xmllint), wget, gzip
+
+Connected to internet (download.tizen.org)
+
+# Usage
+1. Cleanning configurations and build output
+- make distclean
+
+2. Cleanning build output
+- make clean
+
+3. Selecting configurations
+- make menuconfig
+
+4. Making a image (After selecting configurations)
+- make
+
+5. Saving a configuration file (After selection configurations)
+- cp .config configs/xxx_defconfig
+- xxx : configuration name
+
+6. Loading a configuration
+- make xxx_defconfig
+
+
+7. Help
+- make help