rustkas / erlang-simple-string

A wrapper library that attempts to make Erlang's string and lists modules seem coherent to beginners.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Erlang simple string

A wrapper library that attempts to make Erlang's string functions in the string, lists, erlang, and re modules seem coherent to beginners.

The initial version is purely a wrapper for traditional list-based strings. Future versions may:

  • rename some functions to make them more familiar to developers coming from other languages
  • fill some gaps for string functionality
  • add support for binary strings across the set

The library is under the (2-clause) Simplified BSD license.

How to generate documentation

  1. Lounch command in project directory: mkdir doc && cp -f overview.edoc doc/overview.edoc.
  2. Start the shell (erl/werl).
  3. Lounch the code edoc:files(["sstr.erl"], [{dir, "doc"}]). in the shell.
  4. Open file index.html in the doc subfolder.

How to run tests

  1. Start the shell (erl/werl).
  2. Lounch code c(sstr). c(sstr_tests). eunit:test(sstr). in the shell and analyze the results.

About

A wrapper library that attempts to make Erlang's string and lists modules seem coherent to beginners.

License:BSD 2-Clause "Simplified" License


Languages

Language:Erlang 100.0%