|
1 | | -# fosslight-scanner README |
| 1 | +# FOSSLight Scanner README |
2 | 2 |
|
3 | | -This is the README for your extension "fosslight-scanner". After writing up a brief description, we recommend including the following sections. |
| 3 | +FOSSLight Scanner is an opensource project that can perform an analysis for open source compliance at once. It can perform open source analysis of source code, binary and dependency. |
4 | 4 |
|
5 | 5 | ## Features |
6 | 6 |
|
7 | | -Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file. |
| 7 | +This extension enhances user convenience by enabling key functionalities of the Fosslight Scanner project directly within the VS Code development environment. The main features include the functions below and will be consistently updated. |
8 | 8 |
|
9 | | -For example if there is an image subfolder under your extension project workspace: |
| 9 | +1. Running source, binary, and dependency scanner on the root directory |
| 10 | +2. Running source scanner on the currently active file in the code editor |
10 | 11 |
|
11 | | -\!\[feature X\]\(images/feature-x.png\) |
12 | | - |
13 | | -> Tip: Many popular extensions utilize animations. This is an excellent way to show off your extension! We recommend short, focused animations that are easy to follow. |
14 | 12 |
|
15 | 13 | ## Requirements |
16 | 14 |
|
17 | | -If you have any requirements or dependencies, add a section describing those and how to install and configure them. |
18 | | - |
19 | | -## Extension Settings |
20 | | - |
21 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
22 | | - |
23 | | -For example: |
| 15 | +1. Python 3.8+. |
| 16 | +2. (Only for windows) Install Microsoft Build Tools (Microsoft Visual C++ 14.0+) from https://visualstudio.microsoft.com/ko/visual-cpp-build-tools/ |
24 | 17 |
|
25 | | -This extension contributes the following settings: |
26 | | - |
27 | | -* `myExtension.enable`: Enable/disable this extension. |
28 | | -* `myExtension.thing`: Set to `blah` to do something. |
29 | 18 |
|
30 | 19 | ## Known Issues |
31 | 20 |
|
32 | | -Calling out known issues can help limit users opening duplicate issues against your extension. |
| 21 | +TBD |
33 | 22 |
|
34 | 23 | ## Release Notes |
35 | 24 |
|
36 | | -Users appreciate release notes as you update your extension. |
37 | | - |
38 | 25 | ### 1.0.0 |
39 | 26 |
|
40 | | -Initial release of ... |
41 | | - |
42 | | -### 1.0.1 |
43 | | - |
44 | | -Fixed issue #. |
45 | | - |
46 | | -### 1.1.0 |
47 | | - |
48 | | -Added features X, Y, and Z. |
49 | | - |
50 | | ---- |
51 | | - |
52 | | -## Following extension guidelines |
53 | | - |
54 | | -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. |
55 | | - |
56 | | -* [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
| 27 | +Initial release of FOSSLight Scanner VSCode extension. |
57 | 28 |
|
58 | | -## Working with Markdown |
59 | 29 |
|
60 | | -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
61 | 30 |
|
62 | | -* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). |
63 | | -* Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). |
64 | | -* Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. |
65 | 31 |
|
66 | 32 | ## For more information |
67 | 33 |
|
68 | | -* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
69 | | -* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 34 | +* [FOSSLight Scanner Official Website](https://fosslight.org) |
70 | 35 |
|
71 | | -**Enjoy!** |
0 commit comments