Add Windows Commands to TD Guide #189

Merged
Nick Alberelli merged 10 commits from TinyNick/blender-studio-pipeline:feature/add-windows-td-guide into main 2024-01-17 15:44:06 +01:00
3 changed files with 37 additions and 18 deletions
Showing only changes of commit dd5afefae3 - Show all commits

BIN
docs/media/td-guide/Tortoise_SVN_Checkout.jpg (Stored with Git LFS) Normal file

Binary file not shown.

BIN
docs/media/td-guide/Tortoise_SVN_Commit.jpg (Stored with Git LFS) Normal file

Binary file not shown.

View File

@ -1,26 +1,39 @@
# SVN Set-Up
The Blender Studio Pipeline relies on SVN to version control all .blend files used in production. This guide will show you how to install SVN on a workstation.
1. To install SVN please follow the instructions relevant for your system from the [Apache Subversion website](https://subversion.apache.org/packages.html)
- Windows users are recommended to use [TortoiseSVN Client](https://tortoisesvn.net/downloads.html)
2. Navigate to the parent of the folder intended to be the svn repository.
```bash
cd ~/data/your_project_name # Linux / Mac
```
```bash
cd %HOMEPATH%\data\your_project_name # Windows
```
3. Create Repository
- Via Terminal
## Install/Setup SVN
The Blender Studio Pipeline relies on SVN to version control all .blend files used in production. This guide will show you how to install an SVN on a workstation, assuming you already have an SVN server setup. To learn more about how to setup an SVN server visit the [SVN Documentation](https://subversion.apache.org/quick-start#setting-up-a-local-repo)
### Linux/Mac
1. Install SVN Client on your system via the [SVN Documentation](https://subversion.apache.org/packages.html)
2. Use the following command to checkout the current SVN repository into the SVN directory.
```bash
# Windows & Linux/Mac
svnadmin create --fs-type fsfs svn
svn checkout http://your_svn.url ~/data/your_project_name/svn
```
- Via TortoiseSVN
Right-click on the `svn` folder and navigate to `TortoiseSVN>Create Repository Here`
### Windows
1. Download & Install the [TortoiseSVN Client](https://tortoisesvn.net/downloads.html)
2. Navigate to your project's root directory. Right-Click Select the `svn` folder and select `SVN Checkout`
3. Enter the URL to checkout under `URL of repository`
4. Select OK to begin checking out the repository
![Tortoise SVN Checkout Dialogue Box](/media/td-guide/Tortoise_SVN_Checkout.jpg)
## Committing Changes to Repository
### Linux/Mac
To commit changes to the SVN use the following command. For more details see the [SVN Documentation](https://subversion.apache.org/quick-start#committing-changes)
```bash
svn commit -m "My Descriptive Log Message"
```
### Windows
To commit changes from the TortoiseSVN client, follow the steps below. For more information see the [TortoiseSVN Documentation](https://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-dug-commit.html)
1. Navigate to your project's root directory.
2. Right-Click Select the `svn` folder and select `SVN Commit`
3. Enter your commit's message in the box labelled `Message`
4. Review what files have changed in the box labelled `Changes made`
::: info Note
For more details on how to set-up an SVN repository please see the official [SVN Documentation](https://subversion.apache.org/quick-start#setting-up-a-local-repo) and the [TortoiseSVN Documentation](https://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-repository.html)
For more details on how to set-up an SVN repository please see the official [SVN Documentation](https://subversion.apache.org/quick-start) and the [TortoiseSVN Documentation](https://tortoisesvn.net/docs/release/TortoiseSVN_en/tsvn-repository.html)
:::