mirror of
https://github.com/wickedyoda/public-setupfiles.git
synced 2026-11-16 13:31:56 -06:00
docs: add READMEs and wiki documentation for all directories
- Add comprehensive wiki documentation under .github/wiki/ (19 articles) - Add READMEs to directories that lacked them - Fix merge conflict markers in existing READMEs - Update root readme.md with improved structure Co-authored-by: Jarvis <jarvis@wickedyoda.local>
This commit is contained in:
1 parent
b40aaf6f0e
commit
0c62f7495a
42 files changed
+4501
-865
No files matched your search
+44
-34
@@ -1,40 +1,50 @@
|
||||
# git_clone_setup
|
||||
|
||||
<<<<<<< HEAD
|
||||
## Purpose
|
||||
This directory contains files related to **git clone setup**.
|
||||
|
||||
## Contents
|
||||
- `Git_clone_local_checkout.md`
|
||||
|
||||
## Usage
|
||||
- Review each script or configuration file before running
|
||||
- Some scripts may require **root or sudo**
|
||||
- Paths and variables may need adjustment for your environment
|
||||
|
||||
## Notes
|
||||
- This folder is part of the **public-setupfiles** repository
|
||||
- Files are provided as-is for reference or automation
|
||||
|
||||
## Safety
|
||||
Always back up data before running scripts that modify system state.
|
||||
=======
|
||||
## Overview
|
||||
This directory is part of the **public-setupfiles** repository.
|
||||
It contains scripts, configuration files, or resources related to **git_clone_setup**.
|
||||
|
||||
## Usage
|
||||
- Review scripts before execution
|
||||
- Some files may require **root or sudo privileges**
|
||||
- Paths, variables, or credentials may need customization
|
||||
|
||||
## Logging & Output
|
||||
Scripts may generate logs or output files in the same directory or system locations.
|
||||
|
||||
## Safety Notes
|
||||
- Always back up important data before running scripts
|
||||
- Test in a non-production environment when possible
|
||||
- Use at your own risk
|
||||
Helper scripts and documentation for cloning Git repositories.
|
||||
|
||||
---
|
||||
>>>>>>> main
|
||||
|
||||
## Files
|
||||
|
||||
| File | Description |
|
||||
|------|-------------|
|
||||
| `Git_clone_local_checkout.md` | Markdown guide |
|
||||
| `README.md` | This file |
|
||||
|
||||
---
|
||||
|
||||
## Usage
|
||||
|
||||
### Clone a Repository
|
||||
|
||||
```bash
|
||||
# Standard clone
|
||||
git clone https://github.com/user/repo.git
|
||||
|
||||
# With depth (faster)
|
||||
git clone --depth 1 https://github.com/user/repo.git
|
||||
```
|
||||
|
||||
### Check Existing Checkout
|
||||
|
||||
```bash
|
||||
# The Git_clone_local_checkout.md contains a checklist
|
||||
# Read it for step-by-step instructions
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
- Always check the default branch before cloning
|
||||
- Use `--depth 1` for shallow clones when appropriate
|
||||
- Keep clones updated: `git pull`
|
||||
|
||||
---
|
||||
|
||||
## Related Scripts
|
||||
|
||||
- `update-from_repo.sh` — Automated repo sync
|
||||
- `update-from_repo.py` — Python version
|
||||
Reference in new issue
Block a user