From 721b8371a114b806147bdb79d81f77fbe8588df2 Mon Sep 17 00:00:00 2001 From: Ian Rees Date: Sun, 10 Dec 2017 17:31:05 +1300 Subject: [PATCH] Add example git clone command to readme.md --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index 045a5b8..660e3e5 100644 --- a/readme.md +++ b/readme.md @@ -8,7 +8,7 @@ This repository should be used to create new analyzers for the Saleae software. First, fork, clone or download this repository. Forking is recommended if you plan to use version control or share your custom analyzer publicly. -Note - This repository contains a submodule. Be sure to include submodules when cloning. If you download the repository from Github, the submodules are not included. In that case you will also need to download the AnalyzerSDK repository linked above and place the AnalyzerSDK folder inside of the SampleAnalyzer folder. +Note - This repository contains a submodule. Be sure to include submodules when cloning, for example `git clone --recursive https://github.com/saleae/SampleAnalyzer.git`. If you download the repository from Github, the submodules are not included. In that case you will also need to download the AnalyzerSDK repository linked above and place the AnalyzerSDK folder inside of the SampleAnalyzer folder. Once downloaded, first run the script rename_analyzer.py. This script is used to rename the sample analyzer automatically. Specifically, it changes the class names in the source code, it changes the text name that will be displayed once the custom analyzer has been loaded into the Saleae Logic software, and it updates the visual studio project.