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

docs: minor tweaks

Browse Source
This commit is contained in:
Campbell Barton
2014-12-03 23:06:55 +01:00
parent c1eee3c0aa
commit 95c744fd3e
3 changed files with 23 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
client/cli/bam.py
View File

@@ -962,7 +962,7 @@ def create_argparse():
import argparse import argparse
usage_text = ( usage_text = (
"BAM! (Blender Asset Manager)\n" + "BAM!\n" +
__doc__ __doc__
) )

6
docs/source/install/index.rst
View File

@@ -6,12 +6,12 @@ How to get the system up and running.
Webservice Webservice
========== ==========
The webservice is a simple web app based on the Flask framework, plus a few extensions. The web-service is a simple web app based on the Flask framework, plus a few extensions.
In order to get it up and running. In order to get it up and running.
- Create a virtual environment - Create a virtual environment
- Activate the virtual environment - Activate the virtual environment
- Install dependencies with pip3 install -r requirements.txt - Install dependencies with ``pip3 install -r requirements.txt``
- Run the service - Run the service
To learn about the webservice usage, check out the proper (non existing) section. To learn about the web-service usage, check out the proper (non existing) section.

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

@@ -3,14 +3,16 @@ User manual
Using BAM is easy and fun! Provided that: Using BAM is easy and fun! Provided that:
- you know how to use the command line of your os - you know how to use the command line of your system.
- have some experience of how versioning systems work - 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 scracth. Actually, this is not true, and in this guide we will explain to use BAM client from scratch.
.. hint:: Do not try to follow this page as a step-by-step tutorial, since its content might .. hint::
be not completely coherent. The purpose of this manual is simply to explain the bam
workflow from the artist point of view. 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 Project Initialization
@@ -18,7 +20,9 @@ Project Initialization
In order to start working, we need to initialize a *project folder*. This operation should 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 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:: location where we want to store the project folder. Then we can type:
.. code-block:: sh
bam init http://bam:5000/gooseberry bam init http://bam:5000/gooseberry
@@ -36,9 +40,11 @@ Session creation
================ ================
Once the project has been initialized and we are able to browse it remotely, we can proceed 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:
bam co libs/envs/jungle/jungle_opening.blend .. code-block:: sh
bam checkout libs/envs/jungle/jungle_opening.blend
This creates a ``jungle_opening`` folder inside of our ``gooseberry`` project folder, which 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, will contain the ``jungle_opening.blend``, along with all its dependencies (library files,
@@ -66,8 +72,10 @@ We can not:
- rename files - rename files
In order to check what is the status of our edits, we can use ``bam st``, which will print a list In order to check what is the status of our edits, we can use ``bam status``, which will print a list
of edited, added and deleted files. of edited, added and deleted files.
.. note:: Sessions are meant to create a contained and controlled working environment. We should .. note::
never, ever refer to content that is outside of a session folder.
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.