ubvu / template-livecode

Template for livecode repositories (e.g., SWC)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Livecode repository

For learners

This repository keeps track of the code being written by the instructor

  • refresh the page regularly to see the current changes
  • use it to catch up or as a reference when running into errors
  • the folder structure is a good starting point when creating a project yourself

For instructors

Use gitautopush to automatically push your livecode to this repository.

Prerequisites

  • Python and pip installed
  • Git installed
  • GitHub account added to the repository as a Contributor

Installation and usage

  • in a first terminal window git clone this repository to create a tracked working directory
  • if you already cloned this repository a while ago, git pull to avoid conflicts
  • in a second terminal window, install gitautopush with pip install gitautopush
  • in this second terminal window, start observing the folder with the command: gitautopush --sleep <INT> /path/to/my/repo/folder. <INT> is the amount of time (in seconds) between attempts to synchronise the code in the local repository with the remote
  • save the files in the working directory often and regularly (or automatically)
  • double check in the second terminal window if gitautopush automatically pushes your changes to the repository: in case of failure, the errors git throws should be inside the message of gitautopush
  • once you finish your lesson, close gitautopush in the second terminal window with Ctrl+C or close the terminal window altogether

Troubleshooting

  • github requires SSH authentication
  • if you are being asked to enter your passphrase every time git tries to push changes, launch the ssh agent automatically, follow these instructions; note that in certain cases your profile or bashrc file is not read when starting up the shell, in this case add test -f ~/.profile && . ~/.profile or test -f ~/.bashrc && . ~/.bashrc respectively to your .bash_profile.
  • ValueError: A git status command didn't work, are you sure this is a git repository?
    • It might be occuring when there are already some changes to be staged once you launch gitautopush. First, run gitautopush, then start creating files or making changes to the existing ones.
    • Another thing to try is to first commit and push one file manually to the repository, once you have done that and no changes are staged run gitautopush

About

Template for livecode repositories (e.g., SWC)