Update README.md
[scm/bb/tizen.git] / README.md
1 # spec2yocto
2
3 ## Installation
4
5 ### Define the YOCTO_WORKDIR environment variable:
6
7         export YOCTO_WORKDIR=<path_to_your_workdir>
8
9 ### Copy .spec2yoctorc to your home directory
10
11         cp tizen/proto-meta-Tizen_generic/.spec2yoctorc ~/
12
13 ### Create a symbolic link to spec2yocto.py in a directory of your ${PATH}
14
15         ln -sf ~/bin/spec2yocto ${YOCTO_WORKDIR}/yoctoTizen/tools/spec2yocto.py
16
17 You can, of course, replace the "~/bin" with another directory of your choice.
18
19 ### Create a spec2yocto directory in /usr/share
20
21         sudo mkdir /usr/share/spec2yocto
22
23 ### Create a symbolic link to roto-meta-Tizen_generic/rpm_tizen_macro/ in /usr/share/spec2yocto/macro
24
25         sudo ln -sf ${YOCTO_WORKDIR}/tizen/proto-meta-Tizen_generic/rpm_tizen_macro/ /usr/share/spec2yocto/macro
26
27 ## Usage
28
29 ### Execute gitCloneAll.sh (optional)
30
31 This project already contains all the necessary spec files to generate the recipes however those
32 spec files may not be the most recent ones. If you want to generate the recipes from the latest spec
33 files you can use this command which will clone all the tizen projects used in the Tizen Yocto
34 images (note that it will take a while):
35
36         .tizen/tools/gitCloneAll.sh
37
38 Alternatively you can also fetch a specific project:
39
40         .tizen/tools/gitCloneAll.sh <project-name>
41
42 ## Using spec2yocto
43
44 For example, to generate the recipes:
45
46         spec2yocto createRecipes
47
48 For more commands, you can display the help:
49
50         spec2yocto -h
51
52 ## License
53
54 GPL v2
55