From 084020db1b56ea107a66e36fc47afe0eba1e2a13 Mon Sep 17 00:00:00 2001 From: Jason Davis Date: Sat, 11 Nov 2023 13:04:31 -0700 Subject: [PATCH] updates --- docs/tech_docs/git_cheat_sheet.md | 76 +++++++++++++++++++ .../Complete outline novel.md | 0 {docs/projects => projects}/ari.md | 0 .../book_crafting/Novel plot build.md | 0 .../book_crafting/Outline mystery.md | 0 .../book_crafting/Plot Creation.md | 0 .../book_crafting/Script Outline.md | 0 .../book_crafting/Untitled 1.md | 0 .../book_crafting/Untitled.md | 0 .../book_crafting/___outline.md | 0 .../book_crafting/__outline.md | 0 .../book_crafting/_outline (1).md | 0 .../book_crafting/_outline.md | 0 .../book_crafting/action thriller mystery.md | 0 .../book_crafting/first draft.md | 0 .../book_crafting/outline.md | 0 .../book_crafting/scratch (2).md | 0 .../book_crafting/story.md | 0 .../book_crafting/template.md | 0 {docs/projects => projects}/wire.md | 0 20 files changed, 76 insertions(+) create mode 100644 docs/tech_docs/git_cheat_sheet.md rename {docs/projects => projects}/Complete outline novel.md (100%) rename {docs/projects => projects}/ari.md (100%) rename {docs/projects => projects}/book_crafting/Novel plot build.md (100%) rename {docs/projects => projects}/book_crafting/Outline mystery.md (100%) rename {docs/projects => projects}/book_crafting/Plot Creation.md (100%) rename {docs/projects => projects}/book_crafting/Script Outline.md (100%) rename {docs/projects => projects}/book_crafting/Untitled 1.md (100%) rename {docs/projects => projects}/book_crafting/Untitled.md (100%) rename {docs/projects => projects}/book_crafting/___outline.md (100%) rename {docs/projects => projects}/book_crafting/__outline.md (100%) rename {docs/projects => projects}/book_crafting/_outline (1).md (100%) rename {docs/projects => projects}/book_crafting/_outline.md (100%) rename {docs/projects => projects}/book_crafting/action thriller mystery.md (100%) rename {docs/projects => projects}/book_crafting/first draft.md (100%) rename {docs/projects => projects}/book_crafting/outline.md (100%) rename {docs/projects => projects}/book_crafting/scratch (2).md (100%) rename {docs/projects => projects}/book_crafting/story.md (100%) rename {docs/projects => projects}/book_crafting/template.md (100%) rename {docs/projects => projects}/wire.md (100%) diff --git a/docs/tech_docs/git_cheat_sheet.md b/docs/tech_docs/git_cheat_sheet.md new file mode 100644 index 0000000..3e5dab9 --- /dev/null +++ b/docs/tech_docs/git_cheat_sheet.md @@ -0,0 +1,76 @@ +# Git Cheatsheet + +## **1. Remote Repository Commands** + +- **Clone a repository**: + `git clone git@github.com:USER-NAME/REPOSITORY-NAME.git` +- **Push changes to a specific remote branch**: + `git push origin BRANCH-NAME` +- **Pull changes from a specific remote branch**: + `git pull origin BRANCH-NAME` + +## **2. Workflow Commands** + +- **Add all changes to the staging area**: + `git add .` + +- **Commit changes with a message**: + `git commit -m "Your descriptive commit message"` + +## **3. Checking Status & Log History** + +- **Check the current state and changes**: + `git status` + +- **View the commit history**: + `git log` + +## **4. Branching** + +- **Create and switch to a new branch**: + `git checkout -b BRANCH_NAME` + +- **Switch to an existing branch**: + `git checkout BRANCH_NAME` + +- **List all branches**: + `git branch` + +- **Delete a branch**: + `git branch -d BRANCH_NAME` + +## **5. Additional Commands** + +- **Show changes between the working directory and index**: + `git diff` + +- **Revert changes from a specified commit**: + `git revert COMMIT` + +- **Reset the current branch head to a specified commit**: + `git reset COMMIT` + +- **Temporarily save changes**: + `git stash` + +## **6. Tips & Best Practices** + +- Use branches for development. +- Commit regularly with descriptive messages. +- Use pull requests to merge changes. +- Resolve conflicts promptly. + +## **7. Basic Git Syntax (Simplified Model)** + +The basic Git syntax is `program | action | destination`. + +For example: + +- `git add .` is read as `git | add | .`, where the period represents everything in the current directory. +- `git commit -m "message"` is read as `git | commit -m | "message"`. +- `git status` is read as `git | status | (no destination)`. +- `git push origin main` is read as `git | push | origin main`. + +--- + +### Remember: Practice makes you better at Git! Keep this cheatsheet handy. diff --git a/docs/projects/Complete outline novel.md b/projects/Complete outline novel.md similarity index 100% rename from docs/projects/Complete outline novel.md rename to projects/Complete outline novel.md diff --git a/docs/projects/ari.md b/projects/ari.md similarity index 100% rename from docs/projects/ari.md rename to projects/ari.md diff --git a/docs/projects/book_crafting/Novel plot build.md b/projects/book_crafting/Novel plot build.md similarity index 100% rename from docs/projects/book_crafting/Novel plot build.md rename to projects/book_crafting/Novel plot build.md diff --git a/docs/projects/book_crafting/Outline mystery.md b/projects/book_crafting/Outline mystery.md similarity index 100% rename from docs/projects/book_crafting/Outline mystery.md rename to projects/book_crafting/Outline mystery.md diff --git a/docs/projects/book_crafting/Plot Creation.md b/projects/book_crafting/Plot Creation.md similarity index 100% rename from docs/projects/book_crafting/Plot Creation.md rename to projects/book_crafting/Plot Creation.md diff --git a/docs/projects/book_crafting/Script Outline.md b/projects/book_crafting/Script Outline.md similarity index 100% rename from docs/projects/book_crafting/Script Outline.md rename to projects/book_crafting/Script Outline.md diff --git a/docs/projects/book_crafting/Untitled 1.md b/projects/book_crafting/Untitled 1.md similarity index 100% rename from docs/projects/book_crafting/Untitled 1.md rename to projects/book_crafting/Untitled 1.md diff --git a/docs/projects/book_crafting/Untitled.md b/projects/book_crafting/Untitled.md similarity index 100% rename from docs/projects/book_crafting/Untitled.md rename to projects/book_crafting/Untitled.md diff --git a/docs/projects/book_crafting/___outline.md b/projects/book_crafting/___outline.md similarity index 100% rename from docs/projects/book_crafting/___outline.md rename to projects/book_crafting/___outline.md diff --git a/docs/projects/book_crafting/__outline.md b/projects/book_crafting/__outline.md similarity index 100% rename from docs/projects/book_crafting/__outline.md rename to projects/book_crafting/__outline.md diff --git a/docs/projects/book_crafting/_outline (1).md b/projects/book_crafting/_outline (1).md similarity index 100% rename from docs/projects/book_crafting/_outline (1).md rename to projects/book_crafting/_outline (1).md diff --git a/docs/projects/book_crafting/_outline.md b/projects/book_crafting/_outline.md similarity index 100% rename from docs/projects/book_crafting/_outline.md rename to projects/book_crafting/_outline.md diff --git a/docs/projects/book_crafting/action thriller mystery.md b/projects/book_crafting/action thriller mystery.md similarity index 100% rename from docs/projects/book_crafting/action thriller mystery.md rename to projects/book_crafting/action thriller mystery.md diff --git a/docs/projects/book_crafting/first draft.md b/projects/book_crafting/first draft.md similarity index 100% rename from docs/projects/book_crafting/first draft.md rename to projects/book_crafting/first draft.md diff --git a/docs/projects/book_crafting/outline.md b/projects/book_crafting/outline.md similarity index 100% rename from docs/projects/book_crafting/outline.md rename to projects/book_crafting/outline.md diff --git a/docs/projects/book_crafting/scratch (2).md b/projects/book_crafting/scratch (2).md similarity index 100% rename from docs/projects/book_crafting/scratch (2).md rename to projects/book_crafting/scratch (2).md diff --git a/docs/projects/book_crafting/story.md b/projects/book_crafting/story.md similarity index 100% rename from docs/projects/book_crafting/story.md rename to projects/book_crafting/story.md diff --git a/docs/projects/book_crafting/template.md b/projects/book_crafting/template.md similarity index 100% rename from docs/projects/book_crafting/template.md rename to projects/book_crafting/template.md diff --git a/docs/projects/wire.md b/projects/wire.md similarity index 100% rename from docs/projects/wire.md rename to projects/wire.md