Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 2.16 KB

setup.md

File metadata and controls

52 lines (35 loc) · 2.16 KB
Raw

Setup

Creating Your Very Own Fork

Follow this link and pick your student ID from the list. If your ID is not in the list, send me a mail.

Clone your repo using the following command, replacing <<URL>> by the url of your fork (omit the < and >).

# Clone your repo
$ git clone <<URL>> midi-project

# Enter the repository
$ cd midi-project

# Add upstream remote
$ git remote add upstream https://github.com/UCLeuvenLimburg/midi-project-student

Do not dare downloading the code as a zip. It is known that strange things tend to happen to the laptops of those who dare violate this rule. You think those few students using Linux installed it on purpose? Think again.

Also, do not clone your repository into a DropBox/OneDrive/Google Drive managed directory. That's your one way ticket straight to FreeBSD.

GitHub

On the main repository's website, click the Watch button in order to receive notifications about updates.

When updates are made, you can pull them as follows (note that you should first commit/stash all your changes, otherwise git might complain):

$ git pull upstream master

Visual Studio

  • Use midi.sln solution file to open the project in Visual Studio.
  • Select "Show All Files" in the Solution Explorer so as to view the folder structure.
  • Notice the three builds available: Debug, Release and Testing.
    • To run the tests, select the Testing build.
    • To run your own main function, select either Debug or Release. During development, you'll probably want to use the former.

Manual Configuration

This section is meant for those not using Visual Studio. Make the following configuration settings:

  • Add . as include directory and compile from within the src/midi folder. This makes it easier to specify #include paths: they all start from the root of the project. AFAIK, setting . as include directory is done using the -I option. E.g., gcc -I. [other stuff].
  • In order to run the tests, define the TEST_BUILD macro. AFAIK, this can be achieved using the -D option: gcc -DTEST_BUILD [other stuff].