Pentole/readme.org

24 lines
989 B
Org Mode
Raw Permalink Normal View History

2024-08-29 11:35:03 +02:00
* Pentole
Pentole aims to be a companion to the F# standard library. It consists of
various extensions to the core library types and additional libraries for common
operations.
This is a list of the provided modules:
2024-08-29 11:36:30 +02:00
- Option: extend the ~Option~ type with auxiliary functions
2024-08-29 11:35:03 +02:00
- Path: datatype to represent Posix paths
2024-08-29 11:35:40 +02:00
- Result: extend the ~Result~ type with auxiliary functions
2024-08-29 11:35:03 +02:00
- String: extensive string manipulation library
2024-08-29 11:36:30 +02:00
- TestExtensions: provide methods that complements ~Nunit.Framework.Assert~
2024-08-29 11:35:03 +02:00
* Goals
The goals of Pentole are the following:
- target developers that work with distributed systems
- avoid OOP
- use exceptions exclusively when they are the most intuitive approach for the
code at hand
- prefer the ocaml coding style rather than C# Pascal Case oriented style
2024-08-29 11:36:30 +02:00
- avoid dependencies to other companion libraries ~FSharpPlus~ and ~FSharpx~,
2024-08-29 11:35:03 +02:00
thus reimplementing some of their functions verbatim
- be well documented and tested
- target GNU/Linux **exclusively**
2024-08-29 11:38:10 +02:00