You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-18Lines changed: 17 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,50 +7,48 @@ Please find all about the **ALox Logging Library**, including
7
7
***FAQ** and the
8
8
***Change log**
9
9
10
-
at the [ALox Homepage](http://alexworx.github.io/ALox-Logging-Library).
10
+
at the [ALox Homepage](https://alexworx.github.io/ALox-Logging-Library).
11
11
12
12
13
13
14
14
## Overview ##
15
15
16
16
ALox is a software library providing an ecosystem for structured and organized log output.
17
17
18
-
ALox is available as [ALox for C++ 11](http://alexworx.github.io/ALox-Logging-Library/cpp_ref/cppmainpage.html), [ALox for C#](http://alexworx.github.io/ALox-Logging-Library/cs_ref/csmainpage.html) and [ALox for Java](http://alexworx.github.io/ALox-Logging-Library/java_ref/javamainpage.html).
18
+
ALox is available as [ALox for C++ 11](https://alexworx.github.io/ALox-Logging-Library/cpp_ref/cppmainpage.html), [ALox for C#](https://alexworx.github.io/ALox-Logging-Library/cs_ref/csmainpage.html) and [ALox for Java](https://alexworx.github.io/ALox-Logging-Library/java_ref/javamainpage.html).
19
19
20
-
To reach this goal, ALox is featured by **ALib** (see ALib for [C++](https://alexworx.github.io/ALib-Class-Library/index.html),[C#](http://alexworx.github.io/ALox-Logging-Library/cs_ref/alox_cs_mainpage.html),[Java](http://alexworx.github.io/ALox-Logging-Library/java_ref/alox_cs_mainpage.html)), which is a basic utility library that among other goals
20
+
To reach this goal, ALox is featured by **ALib** (see ALib for [C++](https://alib.dev/alib_mod_alox.html),[C#](https://alexworx.github.io/ALox-Logging-Library/cs_ref/alox_cs_mainpage.html),[Java](https://alexworx.github.io/ALox-Logging-Library/java_ref/alox_cs_mainpage.html)), which is a basic utility library that among other goals
21
21
provides *'source-compatible'* types for the three languages.
22
22
23
23
ALox attempts to make logging as easy and intuitive as possible. We want you to **stop adding temporary debug output lines** into your code. Instead, write (with less effort!) short, nice and readable *ALox statements* that live in your code as if they were comment lines. Let ALox do the rest: Add meta information to the output, format the output, filter output based on verbosity level and based on your current topic of interest. Finally, get it all *pruned* out of your release executable, same as your source comments.
24
24
25
25
On the other end of the list, ALox enables **release logging** for productive applications to collect mission critical **metrics from the field**.
26
26
27
-
This is **Version 1903 Revision 0**.
27
+
This is **Version 2402 Revision 0**.
28
28
29
29
## C++ Version ##
30
30
As of library version 1805, the C++ codebase was extracted from this repository.
31
31
**ALox for C++** became a "module" of general purpose class library **"ALib"**.
32
-
Consequently, the C++ sources of ALox are to be retrieved at
33
-
[ALib for C++ Github Repository](https://github.com/AlexWorx/ALib-Class-Library).
34
32
35
-
**ALib for C++** also disposes about a dedicated [homepage](http://alexworx.github.io/ALib-Class-Library).
33
+
Consequently, **ALib for C++** also disposes about a dedicated [homepage](https://alib.dev/alib_mod_alox.html).
36
34
37
35
38
36
## Features ##
39
37
40
-
* Available for **C++ 11** (GNU/Linux, Windows OS, macOS), **C#** (.Net, Windows, Linux, Microsoft, Mono) and **Java**
38
+
* Available for **C++ 17/21** (GNU/Linux, Windows OS, macOS, Raspberry OS), **C#** (.Net, Windows, Linux, Microsoft, Mono) and **Java**
41
39
(with Android support and extensions).
42
40
43
41
***Free software**, published under Boost Software License.
44
42
45
-
* Jump-start **tutorials** for [ALox for C++](http://alexworx.github.io/ALox-Logging-Library/cpp_ref/cpptutorial.html),[ALox for C#](http://alexworx.github.io/ALox-Logging-Library/cs_ref/cstutorial.html) and [ALox for Java](http://alexworx.github.io/ALox-Logging-Library/java_ref/javatutorial.html), **Sample Projects** and pre-configured project files for **different IDEs** and **CMake**.
43
+
* Jump-start **tutorials** for [ALox for C++](https://alib.dev/alib_mod_alox.html),[ALox for C#](https://alexworx.github.io/ALox-Logging-Library/cs_ref/cstutorial.html) and [ALox for Java](https://alexworx.github.io/ALox-Logging-Library/java_ref/javatutorial.html), **Sample Projects** and pre-configured project files for **different IDEs** and **CMake**.
46
44
47
45
***Formatted**, **colorful** and **configurable** log output** with support for ANSI compatible consoles and Windows OS consoles.
48
46
49
47
* Log lines **'clickable' in IDE** to jump to the corresponding source code line (depending on IDE).
50
48
51
49
* Automatic collection of **meta information** like time stamp, time-difference to previous log, executing thread or executing source scope information (platform/language dependent).
52
50
53
-
* Automatic removal, aka **'pruning'**, of *debug-log* statements from release code mostly without the need of pre-processor if/endif code cluttering. Optionally also automatic pruning of *release-log* statements. (In Java: implemented using [Proguard](http://proguard.sourceforge.net), with provision of ready to use configuration files.
51
+
* Automatic removal, aka **'pruning'**, of *debug-log* statements from release code mostly without the need of pre-processor if/endif code cluttering. Optionally also automatic pruning of *release-log* statements. (In Java: implemented using [Proguard](https://proguard.sourceforge.net), with provision of ready to use configuration files.
54
52
55
53
- Minimal intrusiveness in respect to *cluttering* your code and what you need to make it really work.
56
54
@@ -90,31 +88,32 @@ Consequently, the C++ sources of ALox are to be retrieved at
90
88
91
89
* C++ version:
92
90
* Compiled and tested on **GNU/Linux**, **Windows OS** and Apple **macOS**.
93
-
* Accepts **arbitrary objects** to be logged. This goal is reached by using underlying library [ALib Boxing](http://alexworx.github.io/ALox-Logging-Library/cpp_ref/namespaceaworx_1_1lib_1_1boxing.html) which allows to pass 'anything' as a parameter to C++ functions and methods.
94
-
* Accepts **3rd party string types**. This goal is reached by using underlying library [ALib Strings](http://alexworx.github.io/ALox-Logging-Library/cpp_ref/namespaceaworx_1_1lib_1_1strings.html).
91
+
* Accepts **arbitrary objects** to be logged. This goal is reached by using underlying library [ALib Boxing](https://alib.dev/alib_mod_boxing.html) which allows to pass 'anything' as a parameter to C++ functions and methods.
92
+
* Accepts **3rd party string types**. This goal is reached by using underlying library [ALib Strings](https://alib.dev/alib_mod_strings.html).
93
+
***Note: The C++ version moved to a different website:**[ALox for C++](https://alib.dev/alib_mod_alox.html)
95
94
96
95
* and finally: ALox is under **continuous development**. You're invited to contribute!
97
96
98
97
#Alternatives
99
98
The following alternatives to **ALox** may be worth mentioning:
<ErrorText>This project references NuGet package(s) that are missing on this computer. Enable NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105.The missing file is {0}.</ErrorText>
0 commit comments