structure#

In this documentation we talk about the structure of the f-utils project, i.e, how it is organized.

libs#

The framework provided by f-utils consists of a collection of libs, organized into four main categories:

  1. primitive: these are the generic and context free libs, in which the f-utils concepts and systematics are implemented, and in which their main concrete examples are constructed

  2. primary: the context-based libs, which are built by making use of the primitive libs. These libs provides our main utilities

  3. secondary: the derived and more involved libs, constructed from multiple primary libs

  4. other: additional minor libraries

repository#

Independently of the category, all libs are given by a repository in the Github organization f-utils under the name f-{lib}. The only exception is f, which has no suffix. It is a primitive lib and the principal one, being used in each other lib. It is in it that our systematics is implemented.

dot repos#

The f-utils organization also has another kind of repositories: the dot repos. As suggested, they are named under .{name} and have a non-lib context:

  1. .github: organization configuration files

  2. .issues: issues of all libs

  3. .website: files of our website

  4. .template: template directory to build libs