rt/wrolpi-help
1
0
Fork 0
mirror of https://github.com/wrolpi/wrolpi-help.git synced 2026-10-26 02:48:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Repos: document History, Download ZIP, and submodules

Browse source 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Roland 2026-10-06 16:27:39 -06:00
parent 3a4496c60f
commit a35d2244b4
No known key found for this signature in database
GPG key ID: 1BA620CE6C9A4680
1 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/modules/repos/index.md
View file

@ -19,6 +19,7 @@ to date while you have Internet access. You can browse a repo's files and read i
| Download Frequency | How often WROLPi checks for updates. Weekly by default. |
| Mode | **Full history** (default) or **Snapshot**. See [Modes](#modes). |
| Branch | Optional. Empty follows the repo's default branch (usually `main` or `master`). |
| Include submodules | Optional. Also download the other repos this repo includes. See [Submodules](#submodules). |
WROLPi clones the repo in the background; its progress is on the Downloads page. Any git host that supports
`https://` works (GitHub, GitLab, Codeberg, Gitea, sourcehut, and others). SSH URLs, and repos that require a password,
@ -57,6 +58,15 @@ If the source disappears (deleted, made private, or no Internet), **your copy is
**Warning!** Git LFS files are not downloaded; they appear as small text files.
## Submodules
Some repos include other repos, called submodules. Check **Include submodules** to download them too. Submodules are
updated with their repo and use the same Mode.
Only `https://` submodules can be downloaded. If a submodule cannot be downloaded (for example, it uses an SSH URL like
`git@github.com:owner/repo.git`), the repo itself is still updated, and its download shows the submodule's error.
Unchecking **Include submodules** removes the submodules' files.
## Browsing a Repo
> To view a repo, click its name in the Repos table.
@ -66,6 +76,12 @@ open it, or a file to preview it. The README of each directory is shown below it
![Repo Page](repo-page.png)
Click **History** to see the repo's commits, newest first. A Snapshot only keeps the latest commit.
> To copy a repo's files to another computer, click **Download ZIP** on the repo's page.
The ZIP contains the files of the latest commit (no history), so it works on computers without git.
## Search
A repo's name, owner, and README are searchable. Matching repos appear under the **Other** tab of the search results,