Commit 0dbb7c49 authored by ESTERIE Pierre's avatar ESTERIE Pierre
Browse files

some more readmes

parent 46ce0d1b
......@@ -78,5 +78,10 @@ And that's it !
## Documentation
[cl_parser](cl_parser/README.md)
[colors](colors/README.md)
[timers](timers/README.md)
[parallel_manager](parallel_manager/README.md)
:construction: Docs of the modules can be found [here](https://compose.gitlabpages.inria.fr/oldstack/cpp_tools/) (under construction)
# colors : simple colors for you terminal
`colors` is a single header to put color in your terminal.
# Usage
```cpp
#include <iostream>
#include <cpp_tools/colors/colorized.hpp>
...
std::cout << cpp_tools::colors::blue << "some blue" << cpp_tools::colors::reset << '\n';
...
```
# Available colors
`black`
`red`
`green`
`yellow`
`blue`
`magenta`
`cyan`
`white`
`on_black`
`on_red`
`on_green`
`on_yellow`
`on_blue`
`on_magenta`
`on_cyan`
`on_white`
`reset`
`bold`
`faint`
`italic`
`underline`
`underline_off`
`slow_blink`
`rapid_blink`
`blink_off`
`reverse`
`overlined`
# parallel_manager : a helper class for parallelism
:construction: under construction
# timers : a collection of helpful timers
:construction: New timers will be added !
# Simple timer example
```cpp
#include <iostream>
#include <cpp_tools/timers/simple_timer.hpp>
...
auto main() -> int
{
...
// default is millisecond
cpp_tools::timers::timer time{};
// or cpp_tools::timers::timer<std::chrono::microseconds> time{};
// for timings in milliseconds etc ...
time.tic();
// some stuff to time...
// directly : std::cout << " time elapsed : " << time.tac_and_elapsed() << "ms\n";
// or :
time.tac();
std::cout << " time elapsed : " << time.elapsed() << "ms\n";
...
}
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment