Initial commit of Content Screening and Reputation Framework.
[platform/upstream/csr-framework.git] / README
1 #
2 #  Copyright (c) 2013, McAfee, Inc.
3 #  
4 #  All rights reserved.
5 #  
6 #  Redistribution and use in source and binary forms, with or without modification,
7 #  are permitted provided that the following conditions are met:
8 #  
9 #  Redistributions of source code must retain the above copyright notice, this list
10 #  of conditions and the following disclaimer.
11 #  
12 #  Redistributions in binary form must reproduce the above copyright notice, this
13 #  list of conditions and the following disclaimer in the documentation and/or other
14 #  materials provided with the distribution.
15 #  
16 #  Neither the name of McAfee, Inc. nor the names of its contributors may be used
17 #  to endorse or promote products derived from this software without specific prior
18 #  written permission.
19 #  
20 #  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
21 #  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22 #  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
23 #  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
24 #  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25 #  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 #  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27 #  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
28 #  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29 #  OF THE POSSIBILITY OF SUCH DAMAGE.
30 #
31
32 Tizen Content Screening Framework
33 =====================================
34 Following steps to create Tizen content screening framework library:
35 - cd framework (change your current folder to 'framework')
36 - make distclean; make
37 - The library can be found inside 'lib'
38
39 Tizen Content Screening Test Suite
40 =====================================
41 Following steps to create test suite
42 - cd test (change your current folder to 'test')
43 - make distclean; make
44
45 Tizen Web Protection Test Suite
46 =====================================
47 Following steps to create test suite
48 - cd test (change your current folder to 'test')
49 - make distclean; make -f WPMakefile
50
51 Porting
52 =====================================
53 TCS_CC: use this environment variable to specify your cross compiler
54 TCS_LD: use this environment variable to specify your cross linker
55 TCS_AR: use this environment variable to specify your cross ar
56 PORT: x86, arm
57 CFLAGS: use this environment variable to specify your compiler specific compiling flags
58 LD_FLAGS: use this environment variable to specify your linker specific linker flags or libraries
59
60 Example for Tizen 2.0.18 Emulator:
61 export PORT=x86
62 export SDK_HOME=${HOME}/tizen-sdk
63 export CFLAGS="-I$SDK_HOME/platforms/tizen2.0/rootstraps/tizen-emulator-2.0.cpp.partner/usr/include"
64 export LD_FLAGS="-B $SDK_HOME/platforms/tizen2.0/rootstraps/tizen-emulator-2.0.cpp.partner/usr/lib -L$SDK_HOME/platforms/tizen2.0/rootstraps/tizen-emulator-2.0.cpp.partner/lib -L$SDK_HOME/platforms/tizen2.0/rootstraps/tizen-emulator-2.0.cpp.partner/usr/lib -lc-2.13 -lpthread-2.13 -lc_nonshared"
65 export TCS_CC="$SDK_HOME/tools/i386-linux-gnueabi-gcc-4.5/bin/i386-linux-gnueabi-gcc"
66 export TCS_LD="$SDK_HOME/tools/i386-linux-gnueabi-gcc-4.5/bin/i386-linux-gnueabi-gcc"
67 export TCS_AR="$SDK_HOME/tools/i386-linux-gnueabi-gcc-4.5/bin/i386-linux-gnueabi-ar"
68
69