Project structure recommendation

In order to automate some build tasks and to be able to analyze software, a basic folder structure is required and some tools for management.

Folder structure

.
+ .git/
+ .github/
+ .reuse/
+ .vscode/
+ archeology/
+ archive/
+ build/
+ docs/
+ fabricare/
+ input/
+ installer/
+ LICENSES/
+ output/
+ release/
+ source/
+ temp/
+ test/
+ vendor/
- .gitignore
- build.cmd
- build.sh
- CHANGELOG.md
- fabricare.json
- LICENSE
- mkdocs.yml
- README.md
- version.json

.git/

Is recommended that project use a version-control system, preferably Git

.github/

This folder has GitHub recommended information and templates

.reuse/

Folder used by reuse software tool, contain license and copyright specifications

.vscode/

Folder used by Visual Studio Code, should contain basic build tasks to be used from editor

archeology/

Archives of source/artifacts for archeology purposes. Old versions of software, to analyze evolution.

archive/

Contains archives of source at different versions

build/

This folder contains build scripts

docs/

Project documentation

fabricare/

Fabricare build system scripts

input/

Project input data or source code

installer/

Project generated installers

LICENSES

Licenses used by the project, checked by reuse software tool

output/

This folder contain build output

release/

Project release

source/

Project source code

temp/

Temporary objects created by the build process

test/

Scripts/utilities/source used for test

vendor/

External project requirements, like libraries

.gitignore

Folders or files to be ignored (for example temp folder)

build.cmd, build.sh

Main entry point for build

CHANGELOG.md

All notable changes to this project will be documented in this file. Using specification from keep a changelog

fabricare.json

Main config file for fabricare build system

LICENSE

Project license

mkdocs.yml

File with configuration for documentation build system

README.md

Information about the project

version.json

A version information file, using specification from Semantic Versioning

---

The project should use the following recommendations or/and tools:

Semantic Versioning - https://semver.org/

REUSE Software - https://reuse.software/

Git - https://git-scm.com/

Visual Studio Code - https://code.visualstudio.com/

Material for MkDocs - https://squidfunk.github.io/mkdocs-material/

keep a changelog - https://keepachangelog.com/en/1.0.0/

---

MIT License

Copyright (c) 2021-2024 Grigore Stefan <g_stefan@yahoo.com>