ijyliu / ECMA-31330-Project

Econometrics and Machine Learning Group Project
2 stars 1 forks source link

GitHub Explainer #49

Closed ijyliu closed 3 years ago

ijyliu commented 3 years ago

First off, my mistake for not doing this earlier, we really should have discussed this at the last project meeting. But here's how to use the code on this repository and keep things in sync for everybody.

  1. Get Git for Windows (or mac or linux). This comes bundled with GitHub Desktop or can be downloaded separately.
  2. Clone the repository locally. This will produce a local copy which can be synced/updated with this website, like Dropbox or Google Docs, but slightly more manually and in a way that lets us easily track and revert changes and mistakes.
    • On the command line, click the green code button here and copy the http. Then create the folder ~/repo, on windows for me this is C:\Users\ijyli\repo. Then open up the git bash or powershell or bash and navigate to this folder using cd ~/repo and run git clone <http link goes here>.
  3. Keeping your local copy up to date with this website. To download/sync the latest updates run git pull. To upload/sync your entire copy of the repository run the following:
    • git add --all: This 'stages' or prepares all of the files you have changed.
    • git commit -m '<enter a message explaining what you did here>': This step lets you leave a message explaining changes and updates you have made.
    • git push: This step uploads your changes.

If you don't want to run commands and are using GitHub desktop there should be buttons associated with all of these steps. If you are using VSCode you can click on the source control icon on the left and git add and commit using the message box and pull and push using the menu found by clicking on the three dots.