Using FMCat materials repository.md

FMCatalonia - Materials

---

How to get a full local copy of the FMCat materials repository

Create your local repository in any place you like

(NOTE: "FMCat" is just a sample name)

mkdir ~/FMCat
cd ~/FMCat
git clone https://gitlab.com/fmcat/materials.git

To rebuild and get it back to master state (mirror the base staus on the repositori source)

OPTION A: Delete the folder and start over

rm -rf ~/FMCat
mkdir ~/FMCat
cd ~/FMCat
git clone https://gitlab.com/fmcat/materials.git

OPTION B: do a git raw update:

cd ~/FMCat
git pull origin master

---

How to contribute (upload) to the FMCat materials repository

Create a local clone as explained above or cd into it if not already.

git clone https://gitlab.com/fmcat/materials.git

Create a new branch if not already created and switch to it (if not existing it will be created and you will be moved to it)

git checkout NAME_OF_THE_NEW_BRANCH

You can see the existing branches, note that current brach is highlighted

git branch

Modify the /inbox folder as you want. Start creating a new folder and put into it anything you want to propose to incorporate into the repository. Edit files and folders as usual from the Finder, no need to use the terminal ;-)

Add a Readme.md file with the description (optional, but recomended to help others, including the admins)

Add your wanted restrictions with a License.txt file. Otherwise the general license rules of the FMCat repository will apply (MIT)

Stage the all changes (add the changes to the change list). NOte thta the dot "." indicates "all", but can add individual files or folders

git add .

(repeat modifications and stagging as many times as you like)

Commit your changes to the remote system, when you're finished

git commit "your commit message"

Now your changes are on the server as well, but not in the "master branch". Users can see the new files moving into the branch but if you want to convert it to permanent content you must post a "merge request".

When a merge request is received the content is inspected and eventually approved, then merged (mixed with) the master branch.

To push a mege request follow FMCat/materials merge requests.