|
3 | 3 | # SPDX-License-Identifier: Apache-2.0 |
4 | 4 | --> |
5 | 5 |
|
6 | | -# FOSSLight Android |
| 6 | +# FOSSLight Android Scanner |
7 | 7 |
|
8 | | -> List all the binaries loaded on the Android-based model to check which open source is used for each binary, and to check whether the notices are included in the OSS notice (ex-NOTICE.html: OSS Notice for Android-based model). |
| 8 | +**FOSSLight Android Scanner** is a Python package that print all the binaries loaded on the Android-based model to check which open source is used for each binary, and to check whether the notices are included in the OSS notice (ex-NOTICE.html: OSS Notice for Android-based model). |
9 | 9 |
|
10 | | -## License |
11 | | -FOSSLight Android is LGE proprietary license, as found in the LICENSE file. |
12 | 10 |
|
13 | | -## Install |
| 11 | +## 📖 User Guide |
14 | 12 |
|
15 | | -To install fosslight_android, you need to have the following pieces of software on |
16 | | -your computer: |
| 13 | +We describe the user guide in the FOSSLight guide page. |
| 14 | +Please see the [**User Guide**](https://fosslight.org/fosslight-guide-en/scanner/6_android.html) for more information on how to install and run it. |
17 | 15 |
|
18 | | -- Python 3.6+ |
19 | | -- pip |
20 | 16 |
|
21 | | -It is recommended to install it in the [python 3.6 + virtualenv environment](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html). |
| 17 | +## 👏 Contributing Guide |
22 | 18 |
|
23 | | -### Installation via pip (For LGE use only) |
24 | | -You only need to run the following command: |
| 19 | +We always welcome your contributions. |
| 20 | +Please see the [CONTRIBUTING guide](https://fosslight.org/fosslight-guide-en/learn/1_contribution.html) for how to contribute. |
25 | 21 |
|
26 | | -```bash |
27 | | -pip3 install "http://mod.lge.com/hub/osc/fosslight_android/-/archive/master/fosslight_android-master.zip" |
28 | | -``` |
29 | 22 |
|
30 | | -After this, make sure that `~/.local/bin` is in your `$PATH`. |
| 23 | +## 📄 License |
31 | 24 |
|
32 | | -### Installation from source |
| 25 | +FOSSLight Android Scanner is Apache-2.0, as found in the [LICENSE][l] file. |
33 | 26 |
|
34 | | -```bash |
35 | | -$ cd android_binary_analysis/ |
36 | | -android_binary_analysis$ pip3 install . |
37 | | -``` |
38 | | - |
39 | | -## Prerequisite |
40 | | - |
41 | | -When building android, save the build log as a text file. |
42 | | - |
43 | | -```bash |
44 | | -$ source ./build/envsetup.sh |
45 | | -$ make clean |
46 | | -$ lunch aosp_hammerhead-user |
47 | | -$ make -j4 2>&1 | tee android.log |
48 | | -``` |
49 | | - |
50 | | -## Usage |
51 | | - |
52 | | -This tool can do various more things, detailed in the documentation. Here a |
53 | | -short summary: |
54 | | - |
55 | | -### Required Parameters |
56 | | -- `s` --- Android source path. |
57 | | -- `a` --- Android build log file name. (File in Android source path.) |
58 | | - |
59 | | -### Optional Paremeters |
60 | | -- `m` --- Analyze the source code for the path where the license could not be found. |
61 | | -- `p` --- Check files that should not be included in the Packaging file. |
62 | | -- `f` --- Print result of Find Command for binary that can not find Source Code Path. |
63 | | -- `t` --- Collect NOTICE for binaries that are not added to NOTICE.html. |
64 | | -- `d` --- Divide needtoadd-notice.html by binary. |
65 | | -- `i` --- Disable the function to automatically convert OSS names based on AOSP. |
66 | | -- `r` --- result.txt file with a list of binaries to remove. |
67 | | - |
68 | | -### Example |
69 | | -```bash |
70 | | -$ fosslight_android -s /home/test/android_source_path -a android.log -m |
71 | | -``` |
72 | | -- android.log : Exists under the android source path. (/home/test/android_source_path/android.log) |
73 | | -- It is recommended to add the m option. |
74 | | - This is because, if the m option is used, the license is automatically detected based on the source code path for the binary for which the license could not be detected. However, if the m option is added, the script execution time becomes longer. |
75 | | - |
76 | | -## Result files |
77 | | -- fosslight_binary_[datetime].txt : A file that outputs checksum and TLSH values for each binary. |
78 | | -- fosslight_report_[%y%m%d_%H%M].xlsx : Result file output in FOSSLight Report format (Source Path and OSS information are included for each binary) |
79 | | -- fosslight_log_[datetime].txt : FOSSLight Android execution log output file. |
80 | | -### In case of m option |
81 | | -- Files in source_analyzed_[%Y%m%d_%H%M%S] : Result of source code analysis for each path. |
| 27 | +[l]: https://github.com/fosslight/fosslight_android/blob/main/LICENSE |
0 commit comments