docs: fixup
This commit is contained in:
parent
257426f486
commit
98d29eb5f5
56
README.md
56
README.md
|
@ -4,39 +4,60 @@ proof of concept and test repository for pushing beeg repositories to 𝓁𝒶
|
||||||
|
|
||||||
## how do i add _my_ repository?
|
## how do i add _my_ repository?
|
||||||
|
|
||||||
1. manage your git repo with github desktop or via the command line
|
1. add git files to the repository root/folder
|
||||||
|
|
||||||
![gh desktop](https://forge.joshwel.co/mark/stld-asg1/raw/branch/main/Documentation/Screenshot%202024-06-05%20095930.png)
|
|
||||||
|
|
||||||
2. add git files files to the repository root/folder
|
|
||||||
|
|
||||||
- [.gitignore](https://forge.joshwel.co/mark/unity/raw/branch/main/.gitignore)
|
- [.gitignore](https://forge.joshwel.co/mark/unity/raw/branch/main/.gitignore)
|
||||||
- [.gitattributes](https://forge.joshwel.co/mark/unity/raw/branch/main/.gitattributes)
|
- [.gitattributes](https://forge.joshwel.co/mark/unity/raw/branch/main/.gitattributes)
|
||||||
|
|
||||||
2. open your repository in the terminal
|
2. manage your git repo with github desktop or via the command line
|
||||||
|
|
||||||
|
3. open your repository in the terminal
|
||||||
|
|
||||||
![gh desktop](https://forge.joshwel.co/mark/stld-asg1/raw/branch/main/Documentation/Screenshot%202024-06-05%20095930.png)
|
![gh desktop](https://forge.joshwel.co/mark/stld-asg1/raw/branch/main/Documentation/Screenshot%202024-06-05%20095930.png)
|
||||||
|
|
||||||
3. make a repo and follow the forge's instructions
|
run the following:
|
||||||
|
|
||||||
|
```text
|
||||||
|
git checkout -b main
|
||||||
|
git lfs install
|
||||||
|
git config lfs.https://forge.joshwel.co/<username>/<repository>.git/info/lfs.locksverify true
|
||||||
|
```
|
||||||
|
|
||||||
|
4. make a repo and follow the forge's instructions
|
||||||
|
|
||||||
|
![instructions](https://forge.joshwel.co/mark/stld-asg1/media/branch/main/Documentation/Screenshot%202024-06-05%20100151.png)
|
||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> if the project has a github deliverable, you must have different remote names \
|
> if the project has a github deliverable, you must have different remote names \
|
||||||
> i would recommend `origin` pointing to github, and `forge` pointing to the forge
|
> i would recommend `origin` pointing to github, and `forge` pointing to the forge
|
||||||
|
|
||||||
```
|
```text
|
||||||
git checkout -b main
|
|
||||||
git lfs install
|
|
||||||
git config lfs.https://forge.joshwel.co/<username>/<repository>.git/info/lfs.locksverify true
|
|
||||||
git remote add forge https://forge.joshwel.co/mark/<username>/<repository>/
|
git remote add forge https://forge.joshwel.co/mark/<username>/<repository>/
|
||||||
git push -u forge main
|
git push -u forge main
|
||||||
```
|
```
|
||||||
|
|
||||||
4. profit
|
```text
|
||||||
|
$ git push -u origin main
|
||||||
|
Uploading LFS objects: 100% (886/886), 2.9 GB | 45 MB/s, done.
|
||||||
|
Enumerating objects: 4641, done.
|
||||||
|
Counting objects: 100% (4641/4641), done.
|
||||||
|
Delta compression using up to 16 threads
|
||||||
|
Compressing objects: 100% (4637/4637), done.
|
||||||
|
Writing objects: 100% (4641/4641), 51.45 MiB | 7.90 MiB/s, done.
|
||||||
|
Total 4641 (delta 2185), reused 0 (delta 0), pack-reused 0 (from 0)
|
||||||
|
remote: Resolving deltas: 100% (2185/2185), done.
|
||||||
|
To https://forge.joshwel.co/mark/stld-asg1.git
|
||||||
|
* [new branch] main -> main
|
||||||
|
branch 'main' set up to track 'origin/main'.
|
||||||
|
```
|
||||||
|
|
||||||
|
if all goes well it should look something like this,
|
||||||
|
where there is a line for Git LFS (`Uploading LFS objects`)
|
||||||
|
|
||||||
|
5. profit
|
||||||
|
|
||||||
for best results, use remote name `origin` for github, and `forge` for 𝓁𝒶 𝓅𝑜𝒾𝓈𝓈𝑜𝓃 𝒹𝓊 𝒻𝑜𝓇𝑔𝑒
|
for best results, use remote name `origin` for github, and `forge` for 𝓁𝒶 𝓅𝑜𝒾𝓈𝓈𝑜𝓃 𝒹𝓊 𝒻𝑜𝓇𝑔𝑒
|
||||||
|
|
||||||
![instructions](https://forge.joshwel.co/mark/stld-asg1/raw/branch/main/Documentation/Screenshot%202024-06-05%20101101.png)
|
|
||||||
|
|
||||||
```text
|
```text
|
||||||
# push changes to github
|
# push changes to github
|
||||||
git push origin main
|
git push origin main
|
||||||
|
@ -45,12 +66,9 @@ proof of concept and test repository for pushing beeg repositories to 𝓁𝒶
|
||||||
git push forge main
|
git push forge main
|
||||||
```
|
```
|
||||||
|
|
||||||
same things apply to pulling
|
same things apply to pulling, have fun!
|
||||||
|
|
||||||
have fun!
|
|
||||||
|
|
||||||
## i previously didn't have .gitattributes, what now
|
## i previously didn't have .gitattributes, what now
|
||||||
|
|
||||||
it's a very involved process, and git is scary.
|
it's a very involved process, and git is scary. \
|
||||||
|
|
||||||
oh well, give up. restart your git repo if you can, else oops
|
oh well, give up. restart your git repo if you can, else oops
|
||||||
|
|
Reference in a new issue