pobsrc/docs/_build/html/_sources/quickstart.rst.txt


Quickstart
===================================

.. _quickstart:

First you need to create the **.Pobsrc** folder in the root of the project. 
The folder will contain every file necessary for pobsrc to work.


Type :

| ``mkdir myproject`` (on unix)
| ``cd myproject``
| ``pobsrc init``

the .pobsrc folder will be created with thepobsrc.conf file containing the 
directives to instruct rclone during the backup operation.

.. code-block:: ini

    [project]

    projectName=tt
    projectSourceDestRoot=FML://www.freemedialab.org/code

    [options]

    excludeFile=exclusions.txt
    rcloneBinPath=rclone
    rcloneCommand=sync

At this point it is necessary to edit the file by adding the "projectSourceDestRoot".

projectSourceDestRoot is the remote created with rclone containing all our projects. 
The current folder will in fact be created inside.

To do this, make sure that projectName has the name of the current folder.

Now we have to upload the project width:

``pobsrc put``


Options
-------

| ``excludeFile=exclusions.txt``  

file containing exclusions

| ``rcloneBinPath=rclone`` 

rclone binary path

| ``rcloneCommand=sync`` 

rclone command type. `see here <https://rclone.org/commands/>`_