Skip to content
This repository has been archived by the owner on Nov 11, 2024. It is now read-only.

brvtalcake/FManC

Repository files navigation

CodeFactor

FManC

A portable file manager library in C

The project

The goals

The goal of this project is to provide a portable and easy to use library to manage files and their content in general, and in a single library. That means that I really want to incorporate a lot of functionnalities in this lib (for more informations about some ideas I had you can take a look at this file). Another goal is to make UTF-X handling easier, since this is currently something that can be annoying to do in C.

How to find the documentation

If you want to download a PDF documentation, it's here. Here is the HTML documentation, wich looks better to me.

Architecture of the repository

Folder structure

The repository is organized as follow

Folder Content
.github This folder contains the usual workflow files for GitHub actions, and so on.
bin This folder simply contains the Windows DLL (and maybe one day will contain the binary for a CLI app).
third_party_libs This folder contains the submodules used in the library. Please read the additionnal README.
docs This folder contains the built HTML documentation (as mentionned above).
include This folder contains the header files of the library.
lib This folder contains the built library.
man This folder contains the built PDF documentation.
obj This folder contains the object files of the library. You probably don't see it, since .gitignore's are still working, as far I know.
src This folder contains the source files of the library. This folder is divided into many subfolders.
test This folder contains the source files of the unit tests and coverage reports that you may not be able to see (again).

Source code folder structure

TODO.

Credits

The doxygen theme I'll use for my documentation is provided by jothepro and hosted in this repository under the terms of the MIT license.