Skip to content

Commit dd38a56

Browse files
committed
Explain how symbolic links can be used for source code
1 parent 1d5b6d8 commit dd38a56

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

GETTING_STARTED.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ Please read through the [Prerequisites](./README.md#hammer_and_wrench-prerequisi
3838

3939
1. Move the artifacts (e.g. Java jars json files) you want to analyze into the `artifacts` directory.
4040

41-
1. Optionally, create a `source` directory and clone the corresponding source code into it to also scan git data.
41+
1. If you want to analyze Typescript code, create a symbolic link inside the `source` directory that points to the Typescript project or copy the project into it.
42+
43+
1. If you want to include git data like changed files and authors, create a symbolic link inside the `source` directory that points to the repository or clone it in the `source` directory. If you already have your Typescript project in there, you of course don't have to do it twice. If you are analyzing Java artifacts (no source needed), it is sufficient to use a bare clone that only contains the git history without the sources using `git clone --bare`.
4244
4345
1. Alternatively to the steps above, run an already predefined download script
4446

0 commit comments

Comments
 (0)