Skip to content

Getting started!

Jump to bottom
Bebenlebricolo edited this page Feb 2, 2019 · 4 revisions

THIS PAGE IS STILL A WORK IN PROGRESS !

Here you will find basic information about how to get FreeMyCode and how to install it. Speaking of getting FreeMyCode, there is 2 ways you can grab the tool : it is available as a Windows-binary in the Releases tab of this repository, or you might want to compile it from sources.

Note: I only provided a Windows x86 binary distribution as someone wanted to test the tool before having a real stable release for both platforms ; this shall be updated soon with both GNU/Linux and Windows binaries.

Grab it from online releases

As mentioned above, the archive which could be found under the Releases tab only works on Windows x86 platforms at the moment. It is a packaged version of the future Installation folder of FreeMyCode, embedding the binary tool alongside necessary resources, such as Pre-processed licenses files and template configuration files.

Compile it from sources

This is where the fun part starts. Actually, building FreeMyCode is really not overwhelming, as no configuration is needed. However, you might need some extra tools such as Cmake (3.1+) and an up-to-date building toolchain.

Here is a list of the tool you will need for both platforms:

  • CMake version 3.1+
  • Linux : GNU/GCC-G++ > 6

To check gcc version, open a terminal and type : gcc --version

  • Windows : Microsoft Visual Studio with C/C++ language support. Toolchain version > 1916

You might want to know which version you are running with : this Microsoft link might be of help to you.

Building step-by-step

  • Clone the repo on your workspace

git clone <url>

  • make a new directory build/

mkdir build or Right click> New directory

  • change directory to build/

cd build or double click on the newly created build directory

  • run cmake ../

Note: do not use the internal cmake support of Microsoft Visual Studio, it exhibited weird behaviors with internal support. Better stick with the genuine Cmake command line tool

  • Linux : run make install (if build completed, you should have a new FreeMyCode/Install/ folder)
  • Windows : open project located under build/Project.sln (Project msvc solution file)
    • -> click on ALL_BUILD target, choose your release type and generate solution
    • -> Under CMake panel, look for Install > Project
    • -> Same as for Linux build process : new directory Install sould be present in your local repo.

Go back to Home!

Clone this wiki locally