Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
imaginelenses authored Sep 24, 2022
1 parent d8be2e9 commit cd85a36
Showing 1 changed file with 45 additions and 10 deletions.
55 changes: 45 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ A [Git](https://git-scm.com/) integration for [Blender](https://www.blender.org/

![Blendit](https://raw.githubusercontent.com/imaginelenses/blendit/main/splash.png)


Blendit brings ***Version Control*** to Blender.

## Version Control
Expand Down Expand Up @@ -34,43 +33,75 @@ In theory the size of the entire project should be lower than using any other VS
2. Install Blendit [Application Template](https://docs.blender.org/manual/en/latest/advanced/app_templates.html#app-templates).


- Open Blender and click the `Blender Menu Install Application Template` submenu
![Blender Menu](https://docs.blender.org/manual/en/latest/_images/interface_window-system_topbar_menus.png)
- Open Blender and click the `Blender Menu Install Application Template` submenu

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/installTemp.png" alt="Blender Menu">

- Select the downloaded `.zip` file.

3. Blendit Application templates can be selected from the splash screen or `File ‣ New` submenu.
3. Blendit Application templates can be selected from the splash screen or `File ▸ New` submenu.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/openBlendit.png" alt="Blender Menu">

**Note**: The first time you open Blendit it will take a some time to load.

**For Windows**: Run Blender as administrator the first time you open Blendit.

### New Project

- Create a new Project from the splash screen or `File ‣ New Project` submenu.
- Create a new Project from the splash screen or `File ▸ New Project` submenu.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/fileMenuNewProject.png" alt="Blender Menu">

- Select a *location* to save the project and type the *name* of the project in the bottom.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/newProject.png" alt="Blender Menu" loading="lazy">

- Provide your *username* and *email*, on the right, to keep track of who made what changes.

**Note**: If you have use Git and have a global git config file, theses details are auto-filled.


### Open Project

- Open a Project from the splash screen or `File ‣ Open Project` submenu.
- Open a Project from the splash screen or `File ▸ Open Project` submenu.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/fileMenuOpenProject.png" alt="Blender Menu" loading="lazy">

- Locate the project you want to open.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/openProject.png" alt="Blender Menu" loading="lazy">

**Note**: The *username* and *email* details shown are of the previous *commiter* - if that isn't you do change it.

### Commits

- Commits are process of saving snapshots of your project.
- Each Commit requires an accompanying *Commit Message* describing the commit
- Create a new Commit from the *Blendit* panel in the *Properties* area, under *Active Tools and Workspace settings* tab.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/blenditPanel.png" alt="Blender Menu" loading="lazy">

- Each Commit requires an accompanying *Commit Message* describing the commit

### Revert Commit

- You can go back time by reverting to a Commit from the past.
- Revert to a Commit by first selecting it from the list of Commits under the *Branch* subpanel and clicking `Revert to Commit` button

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/revertCommit.png" alt="Blender Menu" loading="lazy">

### Branches

- Branches are the forks in the road, so to speak.
- Create a new Branch by clicking `+` button next to the Branches dropdown in the *Branches* subpanel.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/newBranch.png" alt="Blender Menu" loading="lazy">

An extract from [About Git](https://git-scm.com/about) website. While this is written targeting *Software Development*, most of these points are applicable to *creative workflows* too.
- Change to that Branch by selecting it from the Branches list dropdown.

<img class="img-fluid mb-3 rounded shadow-lg" src="https://github.com/imaginelenses/blenditSite/blob/main/src/assets/branchList.png" alt="Blender Menu" loading="lazy">

Here is an extract from the [About Git](https://git-scm.com/about) website. While this is written targeting *Software Development*, most of these points are applicable to *creative workflows* too.

> - **Frictionless Context Switching.** Create a branch to try out an idea, commit a few times, switch back to where you branched from, apply a patch, switch back to where you are experimenting, and merge it in.
> - **Role-Based Codelines.** Have a branch that always contains only what goes to production, another that you merge work into for testing, and several smaller ones for day to day work.
Expand All @@ -79,6 +110,7 @@ An extract from [About Git](https://git-scm.com/about) website. While this is wr
> <img src="https://git-scm.com/images/about/branches@2x.png" alt="Git Branching" width="500">
### Assets

- All assets like materials, textures, etc. should be stored within the `/assets` folder within the project.
- **Note:** Changes made to the `/assets` folder is ***not*** tracked by Blendit.

Expand All @@ -92,5 +124,8 @@ An extract from [About Git](https://git-scm.com/about) website. While this is wr

Like Blender and Git, Blendit is also licensed under the GNU General Public License.

See [Full License](https://github.com/imaginelenses/blendit/blob/main/LICENSE).


#
*Splash screen image was made following [CG Geek's tutorial](https://youtu.be/72LPW4S8bns).*
*Splash screen image was made following [CG Geek's tutorial](https://youtu.be/72LPW4S8bns).*

0 comments on commit cd85a36

Please sign in to comment.