Skip to content

Latest commit

 

History

History
94 lines (70 loc) · 3.7 KB

README_ENG.md

File metadata and controls

94 lines (70 loc) · 3.7 KB
Raw

mytetra_dev

ENG: Central source repository for MyTetra development.

RUS: Основной репозитарий исходников для разработки MyTetra.

Agreement on the coding (registration code)

When writing code to be guided by the following agreements:

  • Source file encoding: UTF-8;

  • Comments in the code allowed the Russian and English languages;

  • Tab prohibited padding spaces are made;

  • Margin - 2 spaces;

  • Comments must have the same indentation that of the code;

  • The name of the file with the implementation of the class is based on the principle ItIsMyClass.cpp;

  • The name of the file with the title of class is based on the principle ItIsMyClass.h;

  • The name of the class is based on the principle ItIsMyClass;

  • The name of the method is based on the principle itIsMyMethod;

  • The name of the variables is based on the principle itIsVariable;

  • The opening "{" and closing bracket "}" should be on separate lines. It is unacceptable to place an opening bracket in the line for (), if (), etc .;

  • Each newly created method should contain a comment that describes what the method does. So it is desirable to describe the purpose of the method parameters;

  • The header class, after the section is necessary in #include class assignment to write comments.

  • Each header file must have the following structure:

#ifndef _CLIPBBRANCH_H_
#define _CLIPBBRANCH_H_
...
#endif // _CLIPBBRANCH_H_
  • Always use the classes, and classes instead of Qt's containers and containers STL;
  • The program is designed as a cross-platform MyTetra Qt-only application. MyTetra program should not depend on third-party libraries that are not part of Qt. If you need to use a third-party library of its source code to the project.

Branches at GIT

The system Git created two main branches.

  • Master - the main branch with the latest stable release;
  • Experimental - branch to develop.

Besides these two branches have been established in other branches for the implementation of a functional. Upon completion of the changes flow into the branch experimental. After stabilization of the changes in the experimental, the changes flow into the master and release is issued.

Deciding to connect to the development MyTetra, please use the experimental branch for the current code.

Build

MyTetra is a Qt-only program. This means that only the Qt SDK is required to build MyTetra. No additional build libraries are required.

In Linux, the assembly is carried out by the commands:

qmake.
make

Installation is carried out by the command:

make install

The installed binary is located along the path:

/ usr / local / bin / mytetra

On Linux, Windows and MacOs, building can be done through QtCreator. To do this, open the mytetra.pro project in QtCreator, and select:

Build - Build project "mytetra"

Running

To run MyTetra, you need to run the compiled binary. Different operating systems place the binary in different paths. To find out which path the built or installed binary is located in, you need to view the build output or the installation output.

For Linux and MacOs, build generates a binary named mytetra. For Windows, the build generates a binary named mytetra.exe.