archive/blender-asset-manager
Archived
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Docs updates

Browse Source
This commit is contained in:
Francesco Siddi
2014-12-04 11:06:41 +01:00
parent b140c79324
commit 2cd93b317c
4 changed files with 128 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/source/manual/index.rst
View File

@@ -3,16 +3,14 @@ User manual
Using BAM is easy and fun! Provided that:
- you know how to use the command line of your system.
- you know how to use the command line of your os
- have some experience of how versioning systems work
Actually, this is not true, and in this guide we will explain to use BAM client from scratch.
Actually, this is not true, and in this guide we will explain to use BAM client from scracth.
.. hint::
Do not try to follow this page as a step-by-step tutorial, since its content might
be not completely coherent. The purpose of this manual is simply to explain the bam
workflow from the artist point of view.
.. hint:: Do not try to follow this page as a step-by-step tutorial, since its content might
be not completely coherent. The purpose of this manual is simply to explain the bam
workflow from the artist point of view.
Project Initialization
@@ -20,9 +18,7 @@ Project Initialization
In order to start working, we need to initialize a *project folder*. This operation should
be done only once. To create a project folder we need to open our terminal, and go to the
location where we want to store the project folder. Then we can type:
.. code-block:: sh
location where we want to store the project folder. Then we can type::
bam init http://bam:5000/gooseberry
@@ -40,11 +36,9 @@ Session creation
================
Once the project has been initialized and we are able to browse it remotely, we can proceed
checking out a file from it. For example we can type:
checking out a file from it. For example we can type::
.. code-block:: sh
bam checkout libs/envs/jungle/jungle_opening.blend
bam co libs/envs/jungle/jungle_opening.blend
This creates a ``jungle_opening`` folder inside of our ``gooseberry`` project folder, which
will contain the ``jungle_opening.blend``, along with all its dependencies (library files,
@@ -72,10 +66,32 @@ We can not:
- rename files
In order to check what is the status of our edits, we can use ``bam status``, which will print a list
In order to check what is the status of our edits, we can use ``bam st``, which will print a list
of edited, added and deleted files.
.. note::
.. note:: Sessions are meant to create a contained and controlled working environment. We should
never, ever refer to content that is outside of a session folder.
Committing changes
==================
Once we are happy with the changes we made to the session, we can sent id back to the server, which
will take care of versioning and merging it back into the project.
To commit a change, simply type::
bam ci -m 'Updated trees'
If you are outside the session folder, you have to specify it::
bam ci jungle_opening -m 'Updated trees'
After committing, we can keep working in the same session, and do further commits.
Updatding and existing session
==============================
At the moment it is not possible to update the session (if another artist updates one of the assets
for example, we would like such asset to be updated in all the sessions using it).
Sessions are meant to create a contained and controlled working environment. We should
never, ever refer to content that is outside of a session folder.