Set up - Estia-1a/projetGenieInfo_public GitHub Wiki

Project Genie Info

  1. Prerequisites
  2. Clone project
  3. Install librairies
  4. Install
  5. Let's start working

1 Prerequisites

1-1 Install required extensions

  • Go to "Extensions" view (CTRL + Shift + X)
  • Use search bar to find and install GitHub Pull Requests and Issues
  • Use search bar to find and install CMake and CMake tool support for VS Code

1-2 Connect your GitHub Account

  • Go to "GitHub" view
  • Click on "Sign in"
  • Allow GitHub Pull Requests and Issues extension
  • In browser, click on "choisir une application", then "ouvrir le lien"

github_signin-3 github_signin-4

  • Click on "Open" in the next pop-up

github_signin-5

  • In VS Code, click on "yes" button in the bottom right pop-up

github_signin-6

  • If you see "You are signed in now and can close this page." in your browser, you have successfully connected your GitHub account to VS Code.

in the terminal (ctrl + j) check that your git configuration has the correct name and email address (either your estia or the email address in https://github.com/settings/emails)

$ git config user.name
dhmmasson
$ git config user.email
[email protected]

If you want to update your email :

$ git config user.email [email protected]

2 Clone project

  • Open command palette (CTRL + SHIFT + P)
  • Type "clone" and select "GIT: clone"
  • Select "Clone from Github"
  • Select "Estia-1a/pgi-2023-TeamName" project
  • Select a location for the project WARNING: No accents in your folder names! Otherwise, your project will not compile.
  • Select "open" to: Would you like to open the cloned repository?
  • Select "yes" to: Do you trust the authors?

3 Install librairies

The project use two libraries : estia-image to handle reading and writing image files, and getopt to handle the command line arguments. Both of those library must be copied into your project folder. You need to get the binaries appropriate to your architecture.

  1. Identify your target architecture : in the a terminal type gcc -v and read what is TARGET. it should read something ending in mingw32 or mingw64. **EDIT 2025, on most machine it seems that the compiler require the mingw64 architecture for the libraries. ** 2, Go to the release https://github.com/Estia-1a/projetGenieInfo_public/releases and select v2.0.1( then:

estia-image

  • Download the estia-image zip file correponding to your setup
  • Unzip the file
  • open the unzipped folder
  • Move the estia-image/ folder in your project (near src/)

getopt

  • Download the getopt zip file correponding to your setup
  • Unzip the file
  • open the unzipped folder
  • Move the getopt/ folder in your project (near src/ and estia-image/)

the final structure should look exactly like that

  • .github
  • .vscode
  • estia-image
    • include
      • estia-image.h
    • lib
      • libestia-image.a
  • getopt
    • include
      • getopt.h
    • lib
      • libgetopt.a
  • images
  • src

Check your configuration

  • Set up a bash terminal :
    • Ctrl + shift + p
    • ```>Select Default Shell``
    • Select Git bash
  • Run the test task :
    • Ctrl + Shift + P
    • ```>Tasks: Run Task``
    • ``Estia: Validate your installation```

4 Install

To install project you can either:

4-1 Install in VS Code command line

  1. The command line version is usually nicer because the output has colors for errors and warnings. For that you need to set your terminal as git bash```` ( open the command palette (Ctrl+Shift+p) and type >Terminal: Select default profile, select git bash```)

  2. Open a new terminal from the menu and type the following command to configure cmake

  • cmake -B build
  1. To build the project (compiling and creating the executable file)
  • cmake --build build
  1. To move freud.exe from the build directory to the root directory
  • cmake --install build
  1. To test your program
  • ./freud.exe -f images/input/image.jpeg -c helloworld

4-2 Install with VS Code CMAKE extension interface

  • Open command palette (CTRL + SHIFT + P) and type CMake and choose : "CMake: Configure"
  • Choose : GCC 13.2.0 [...] (or another version of GCC)
  • Build your project: click on "Build" button of the bottom blue bar (see bellow)

  • You must have a build folder now

  • Install your project:

    • Click on [all]
    • Choose install
    • Click on "Build" button of the bottom blue bar

  • Run your code:

5. Importing the features to be implemented

Github has a set of workflows that can run onto your repository to automatically administrate your repository (validate the code, create or manage issues... ). Unfortunately classroom does not enable them by default. One member of the team should edit the file .github/workflows/create-issues.yml. Remove the "X" in the first line name: Import issues from Template X, then commit and push the change.

Once done you should be able to go to the Actions tab on your github repository and run the action Import issues from Template

This will create issues (it may take some times). Each issue is related to a task you have to do in this project.

6 Let's start working

Now, refer to the wiki to start working !

Tutorial