diff --git a/Update-Pixelator-Version.-.md b/Update-Pixelator-Version.-.md index faabe9b..d91f70d 100644 --- a/Update-Pixelator-Version.-.md +++ b/Update-Pixelator-Version.-.md @@ -47,12 +47,63 @@ The new code can be downloaded from `gitea.psi.ch`. There are 3 ways to do this: mv pixelator stxm-new-version rm Pixelator-master.zip ``` + or + ``` + cd ~/work + tar -xfvz Pixelator-master.tar.gz + mv pixelator stxm-new-version + rm Pixelator-master.tar.gz + ``` + replace `stxm-new-version` with whatever directory name you wish to use (including the date is useful). +# Switch Branch (optional) + +If you wish to use a feature that is still under development, it might be in a special branch of the code (the standard branch is called `master`). To list the available branches: +``` +git branch -a +``` +The current branch will be marked with an `*`. To switch to a different branch: +``` +git checkout branch-name +``` + +# Compiling + +The dependencies should already be installed (but it is possible for new ones to be added). To compile Pixelator +``` +cd ~/work/stxm-new-version +autoreconf -i +mkdir build +cd build +../configure +make +``` + +Most of the time, there are no significant changes to the Orocos code and so there is no need to compile this part again. However, if you do wish to compile the Orocos code: +``` +. ~/orocos/setup.sh +cd ~/work/stxm/PixelatorRealtime/ +make +make install +``` + + +# Config files + +It typically makes sense to copy the config files from the previously installed version of Pixelator. Check your startup script to see their location, but in a standard installation: +``` +cd ~/work/ +cp -r stxm-old-version/PixelatorController/config stxm-new-version/PixelatorController/config +``` + # Activate a Different Version A different version can be made active by redirecting the link to point at the directory of the desired version. From the `~/work/` directory, use the command: ```ln -sf $TARGET $LINK_NAME``` -where `$TARGET` is the directory name of the desired version and $LINK_NAME is the path that your startup scripts expect (e.g. `stxm` or `stxm-test`). +where `$TARGET` is the directory name of the desired version (e.g. `stxm-new-version`) and $LINK_NAME is the path that your startup scripts expect (e.g. `stxm` or `stxm-test`). + +This command can be used both to switch to a new version and back to an older version. +