Skip to content

Commit

Permalink
continue doc
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Diemand <codieplusplus@apax.net>
  • Loading branch information
CodiePP committed Jan 14, 2024
1 parent 782acc0 commit 3156e17
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
1 change: 1 addition & 0 deletions doc/01_Content.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@

## Data [Storage](04_Storage.md)

## Code organisation in [Modules](05_Modules.md)
73 changes: 73 additions & 0 deletions doc/05_Modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
[Content](01_Content.md)

# Modules

The code is organised in modules which can further be grouped:


## Core modules

### Configuration
[Configuration](../theories/Configuration.v)

Defines program configuration.

### Nchunks
[Nchunks](../theories/Nchunks.v)

Provides a special type *Nchunks* to restrict it to the interval `[1,256]`

### Buffer
[Buffer](../theories/Buffer.v)

An abstraction of a memory blob.

### Environment
[Environment](../theories/Environment.v)

This module provides high-level API.

### Assembly
[Assembly](../theories/Assembly.v)

This module implements the functionality of an assembly.


## Functionality modules

### BackupPlanner
[BackupPlanner](../theories/BackupPlanner.v)

Computes a plan to backup a file.

### AssemblyCache
[AssemblyCache](../theories/AssemblyCache.v)

Provides a cache of assemblies and recreates them on demand.


## Other modules

### Conversion
[Conversion](../theories/Conversion.v)

various conversion primitives.

### Filesupport
[Filesupport](../theories/Filesupport.v)

This module provides types on file information.

### Utilities
[Utilities](../theories/Utilities.v)


### MakeML
[MakeML](../theories/MakeML.v)

This module defines the code export to *OCaml*.

### Version
[Version](../theories/Version.v)

This module defines the current version.

0 comments on commit 3156e17

Please sign in to comment.