Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Modify cloning instructions #10

Merged
merged 2 commits into from
Aug 10, 2024
Merged

Docs: Modify cloning instructions #10

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2872ae
Modify cloning instructions
she3o Aug 9, 2024
1adbba4
Apply suggestions from code review
she3o Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
she3o marked this conversation as resolved.
Show resolved Hide resolved

```sh
git clone https://github.com/Luc-Mcgrady/Anki-Search-Stats-Extended.git --recursive --depth=1 --shallow-submodules
she3o marked this conversation as resolved.
Show resolved Hide resolved
```

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.

she3o marked this conversation as resolved.
Show resolved Hide resolved
### Linux / Mac

run make to setup source files
Expand Down
Loading