Guidelines/ProjectStructure.md

33 lines
972 B
Markdown
Raw Normal View History

2020-04-17 15:39:20 +03:00
# Structure of QuasarApp Projects
## Strict observance
* All Projects created after 01/01/2020 must be new structure:
```
2020-04-17 15:41:09 +03:00
Main git repository
2020-04-17 15:39:20 +03:00
├── Main build system file (cmake or qmake)
2020-09-04 12:41:07 +03:00
├── ProjectDir(src)
2020-04-17 15:39:20 +03:00
| ├── Private submodule for Project
| ├── src
│ │ ├── sources files
2020-04-17 15:41:09 +03:00
| | └── resources files (or folder with resources files)
2020-04-17 15:39:20 +03:00
| └── Build system file (cmake or qmake)
├── Tests
│ ├── Private submodule for tests
│ ├── src
│ │ ├── sources files
2020-04-17 15:41:09 +03:00
| | └── resources files (or folder with resources files)
2020-04-17 15:39:20 +03:00
| └── Build system file (cmake or qmake)
2020-04-18 23:04:17 +03:00
├── Doc/Docs
2020-04-17 15:39:20 +03:00
│ ├── Private submodule for documentation
2020-04-17 15:41:09 +03:00
│ └── Documentation files
2020-04-17 15:39:20 +03:00
└── Global submodule for all projects
```
## Recommendations
2020-04-17 15:41:09 +03:00
* Use CMake build system
2021-04-03 21:15:28 +03:00
# For create new repositoy use the [CMakeProject](https://github.com/QuasarApp/CMakeProject) template.