Hacking:Source Tree: Difference between revisions

From Seamly
Content added Content deleted
(Created page with "__TOC__ This page describes how the Valentina source is organized - it will describe what's inside each directory of Valentina, and should help you navigate your way through...")
 
(Changing valentina to seamly / seamly2D)
 
Line 1: Line 1:
__TOC__
__TOC__


This page describes how the Valentina source is organized - it will describe what's inside each directory of Valentina, and should help you navigate your way through the source.
This page describes how the Seamly2D source is organized - it will describe what's inside each directory of Seamly2D, and should help you navigate your way through the source.


== Root directory ==
== Root directory ==
The main directory of the project. Open file ''Valentina.pro'' in Qt Creator for begin work the the code. File ''ChangeLog.txt'' contains current changelog state. Don't forget before each [[Hacking:Making pull requests|pull request]] to add your changes to this file.
The main directory of the project. Open file ''Seamly2D.pro'' in Qt Creator for begin work the the code. File ''ChangeLog.txt'' contains current changelog state. Don't forget before each [[Hacking:Making pull requests|pull request]] to add your changes to this file.
=== dist ===
=== dist ===
Contains scripts and files for building deb, rpm, ebuild, MacOS and Windows install packages.
Contains scripts and files for building deb, rpm, ebuild, MacOS and Windows install packages.
Line 12: Line 12:
Contains translation files. The directory mostly used for storing files related to the project, but not need for building. Such files can be svg versions of images, some important documents, special templates.
Contains translation files. The directory mostly used for storing files related to the project, but not need for building. Such files can be svg versions of images, some important documents, special templates.
=== src ===
=== src ===
Contains the all source code of Valentina.
Contains the all source code of Seamly2D.
==== app ====
==== app ====
Contains the source code of Valentina's binaries.
Contains the source code of Seamly2D's binaries.
===== app/share =====
===== app/share =====
Look at this directory if you seek collection of files we use for unit testing and measurement files we deploy with the application.
Look at this directory if you seek collection of files we use for unit testing and measurement files we deploy with the application.
===== app/tape =====
===== app/tape =====
The source code of Valentina's measurement editor.
The source code of Seamly2D's measurement editor.
===== app/valentina =====
===== app/seamly2D =====
The source code of Valentina's main binary.
The source code of Seamly2D's main binary.
==== libs ====
==== libs ====
Contains the all source code of related to Valentina libraries.
Contains the all source code of related to Seamly2D libraries.
===== libs/ifc =====
===== libs/ifc =====
The Ifc library used for converting old pattern/measurement format to new version.
The Ifc library used for converting old pattern/measurement format to new version.
Line 51: Line 51:
===== test/ParserTest =====
===== test/ParserTest =====
Qmuparser's tests.
Qmuparser's tests.
===== test/ValentinaTest =====
===== test/Seamly2DTest =====
All Valentina's tests.
All Seamly2D's tests.

Latest revision as of 18:39, 13 April 2018

This page describes how the Seamly2D source is organized - it will describe what's inside each directory of Seamly2D, and should help you navigate your way through the source.

Root directory[edit | edit source]

The main directory of the project. Open file Seamly2D.pro in Qt Creator for begin work the the code. File ChangeLog.txt contains current changelog state. Don't forget before each pull request to add your changes to this file.

dist[edit | edit source]

Contains scripts and files for building deb, rpm, ebuild, MacOS and Windows install packages.

scripts[edit | edit source]

Contains several useful scripts we often use for automate our doings.

share[edit | edit source]

Contains translation files. The directory mostly used for storing files related to the project, but not need for building. Such files can be svg versions of images, some important documents, special templates.

src[edit | edit source]

Contains the all source code of Seamly2D.

app[edit | edit source]

Contains the source code of Seamly2D's binaries.

app/share[edit | edit source]

Look at this directory if you seek collection of files we use for unit testing and measurement files we deploy with the application.

app/tape[edit | edit source]

The source code of Seamly2D's measurement editor.

app/seamly2D[edit | edit source]

The source code of Seamly2D's main binary.

libs[edit | edit source]

Contains the all source code of related to Seamly2D libraries.

libs/ifc[edit | edit source]

The Ifc library used for converting old pattern/measurement format to new version.

libs/qmuparser[edit | edit source]

The math parser library. Used for evaluating formulas, parsing formulas and translation measurement names.

libs/vdxf[edit | edit source]

The VDxf library used for export a layout to dxf format.

libs/vformat[edit | edit source]

Contains class for managing measurements.

libs/vgeometry[edit | edit source]

Contains classes for working with geometric objects: arc, curve, point, etc.

libs/vlayout[edit | edit source]

The library for generating a layout.

libs/vmisc[edit | edit source]

The library that contains common classes.

libs/vobj[edit | edit source]

The VObj library used for export a layout to obj format.

libs/vpatterndb[edit | edit source]

Contains classes for storing data about pattern.

libs/vpropertyexplorer[edit | edit source]

Contains classes of the tool property browser. You will see it when click on any object: point, line, curve.

libs/vtools[edit | edit source]

Contains all calsses of all tools.

libs/vwidgets[edit | edit source]

Contains classes of custom widgets.

test[edit | edit source]

Contains the source code of all unit tests.

test/ParserTest[edit | edit source]

Qmuparser's tests.

test/Seamly2DTest[edit | edit source]

All Seamly2D's tests.