Project Structure

[alanmasu]

Hi,
I’m a bit confused about how to place some modules of a project that I’m working on;
for maintainability I separated the definitions and the declaration of functions & classes, but for now I have the *.h in ../include end the *.cpp in ../src, could be better to place those files in ..lib/<module name> ?

[EDIT]:
In that case, what is the correct use of the ../include directory and when I should place a file in that directory instead creating a module in the ../lib directory?

[EDIT 2]:
In my case I have two modules: fsUtilities and deviceManager, and the last one depends on the first, what I should do??

Alan

[sivar2311]

The README files in both folders actually explain this quite well.

include:

This directory is intended for project header files.
A header file is a file containing C declarations and macro definitions
to be shared between several project source files. You request the use of a
header file in your project source file (C, C++, etc) located in src folder
by including it, with the C preprocessing directive `#include’.
…

Headerfiles are included by #include "headername.h"

lib:

This directory is intended for project specific (private) libraries.
PlatformIO will compile them to static libraries and link into executable file.
The source code of each library should be placed in an own separate directory
(“lib/your_library_name/[here are source files]”).
…

Libraries are included by #include <libname.h>

@alanmasu

In my case I have two modules: fsUtilities and deviceManager, and the last one depends on the first, what I should do??

If both are libraries, write proper library.json manifest files and add fsUtilities to the dependencies of deviceManager.

Otherwise simply put the files into include (or src) folder and use “#include”.