docs: add full clone and Git LFS setup guide
This commit is contained in:
88
README.md
88
README.md
@@ -1,3 +1,85 @@
|
||||
Deviant Mobile V1.1.1
|
||||
New updates and changes will be used in this repo.
|
||||
This is the official Deviant Mobile Repo.
|
||||
# Deviant Mobile Repository
|
||||
|
||||
Official source repository for the Deviant Mobile Unity project.
|
||||
|
||||
## Project Overview
|
||||
|
||||
This repository contains the full Unity game project, including:
|
||||
|
||||
- Unity assets and scenes
|
||||
- Gameplay and UI scripts
|
||||
- Audio, visual, and character content
|
||||
- Build and project settings
|
||||
- Large binary assets tracked with Git LFS
|
||||
|
||||
Because this project uses many large files, Git LFS is required for every developer machine.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Install these before cloning:
|
||||
|
||||
1. `git` (2.30+ recommended)
|
||||
2. `git-lfs` (3.x recommended)
|
||||
|
||||
Then initialize LFS once on your machine:
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
```
|
||||
|
||||
## Clone Instructions (Full Working Copy)
|
||||
|
||||
Use SSH (recommended):
|
||||
|
||||
```bash
|
||||
git clone ssh://git@git.uncaptured.co:2222/Uncaptured_co/deviant-mobile.git
|
||||
cd deviant-mobile
|
||||
git lfs pull
|
||||
```
|
||||
|
||||
Or use HTTPS:
|
||||
|
||||
```bash
|
||||
git clone https://git.uncaptured.co/Uncaptured_co/deviant-mobile.git
|
||||
cd deviant-mobile
|
||||
git lfs pull
|
||||
```
|
||||
|
||||
Optional full-history LFS fetch:
|
||||
|
||||
```bash
|
||||
git lfs fetch --all
|
||||
```
|
||||
|
||||
## Verify Your Clone
|
||||
|
||||
Run:
|
||||
|
||||
```bash
|
||||
git lfs ls-files | wc -l
|
||||
```
|
||||
|
||||
You should see a large count (thousands of LFS pointers). If files are missing, run:
|
||||
|
||||
```bash
|
||||
git lfs pull
|
||||
```
|
||||
|
||||
## Common Issues
|
||||
|
||||
- `Not Found [404]` during `git lfs pull`:
|
||||
- Make sure you are on the correct repository remote.
|
||||
- Re-run `git lfs pull`.
|
||||
- If the issue persists for a specific object, contact the repository maintainer.
|
||||
|
||||
- Authentication errors:
|
||||
- Confirm your SSH key or HTTPS credentials are valid for `git.uncaptured.co`.
|
||||
|
||||
- Slow LFS transfers:
|
||||
- Retry the pull and ensure network/proxy path is stable.
|
||||
|
||||
## Notes for Contributors
|
||||
|
||||
- Do not commit large binaries outside Git LFS-tracked paths.
|
||||
- Keep Unity meta files consistent with assets.
|
||||
- Use small, focused commits for easier review and rollback.
|
||||
|
||||
Reference in New Issue
Block a user