From c2872aee702e177bff9fe04b6516b6056e1a83c3 Mon Sep 17 00:00:00 2001 From: Anas Sheashaey Date: Fri, 9 Aug 2024 17:38:41 +0300 Subject: [PATCH 1/2] Modify cloning instructions --- readme.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index 60433ae..567e242 100644 --- a/readme.md +++ b/readme.md @@ -72,11 +72,22 @@ Like the new anki stats screen? Want more? This is the addon for you. Building this with make addon works on linux and will probably work on mac -Clone this repo recursively (It contains all anki's source files, sorry) -``` -https://github.com/Luc-Mcgrady/Anki-Search-Stats-Extended.git --recursive +### Cloning the Repository + + To clone the repository along with its submodule (Anki codebase), you can use the following command: + +```sh +git clone https://github.com/Luc-Mcgrady/Anki-Search-Stats-Extended.git --recursive --depth=1 --shallow-submodules ``` +This command performs a shallow clone, fetching only the latest commit +for both the main repository and its submodule. + +Note: Unless you plan to perform Git actions that modify past commits +(e.g., `git rebase`), using `--depth 1` and `--shallow-submodules` is a safe and +efficient choice. +It reduces the amount of data cloned and speeds up the process. + ### Linux / Mac run make to setup source files From 1adbba416b7504bd136cef4ab22b72b051f1df55 Mon Sep 17 00:00:00 2001 From: Anas sheashaey Date: Sat, 10 Aug 2024 16:34:44 +0300 Subject: [PATCH 2/2] Apply suggestions from code review These suggestions were made by @Luc-Mcgrady in PR #10. - Remove exhaustive description of git clone commands. - Remove --depth=1. - Fix Typos. Co-authored-by: Luc Mcgrady --- readme.md | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/readme.md b/readme.md index 567e242..5551486 100644 --- a/readme.md +++ b/readme.md @@ -74,20 +74,12 @@ Building this with make addon works on linux and will probably work on mac ### Cloning the Repository - To clone the repository along with its submodule (Anki codebase), you can use the following command: +To clone the repository along with its submodule (the Anki codebase), you should use the following command: ```sh -git clone https://github.com/Luc-Mcgrady/Anki-Search-Stats-Extended.git --recursive --depth=1 --shallow-submodules +git clone https://github.com/Luc-Mcgrady/Anki-Search-Stats-Extended.git --recursive --shallow-submodules ``` -This command performs a shallow clone, fetching only the latest commit -for both the main repository and its submodule. - -Note: Unless you plan to perform Git actions that modify past commits -(e.g., `git rebase`), using `--depth 1` and `--shallow-submodules` is a safe and -efficient choice. -It reduces the amount of data cloned and speeds up the process. - ### Linux / Mac run make to setup source files