Skip to content

Commit 3a64300

Browse files
Updated README.md
1 parent 6fc4906 commit 3a64300

File tree

1 file changed

+30
-13
lines changed

1 file changed

+30
-13
lines changed

README.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@ This is a snapshot of the latest Release of the **TeaScript C++ Library** for em
33
**Extend** your applications dynamically during runtime with TeaScript.<br>
44
Once your application has **customization points** for TeaScript each installation/distribution can be extended/modified **without** expensive re-compile and deployment procedure with arbitrary and individual functionality.
55

6-
This Library can be used as **header only** library and is **dependency free** for fully C++20 supporting compilers / C++ standard libraries.
7-
8-
Provided with this Library is a **demo app** for illustrating the C++ API usage and a basic way for execute TeaScript files.
9-
106
**TeaScript** is an embeddable and standalone **Multi-Paradigm script language** close to C++ syntax but easier to use.<br>
117
More information about TeaScript is available here: https://tea-age.solutions/teascript/overview-and-highlights/
128

9+
This Library can be used as a **header only** library and is **dependency free** for fully C++20 supporting compilers / C++ standard libraries.
10+
11+
Provided with this Library is a **demo app** for illustrating the C++ API usage and a basic way for execute TeaScript files.
12+
1313
A Library bundle with more example scripts as well as a full featured **TeaScript Host Application** for execute **standalone** script files,
14-
an interactive shell, a REPL, debugging options, time measurement and more can be downloaded for free here: <br>
14+
an interactive shell, a REPL, debugging options, time measurement and more can be downloaded for free here (including its source): <br>
1515
https://tea-age.solutions/downloads/
1616

1717
# About TeaScript
18-
**What is new in TeaScript 0.12.0?** TeaScript 0.12 comes with Colored Output, Format String, Forall Loop, Sequences and interactive debugging.<br>
19-
<br>Get all infos in the news article:<br>
20-
https://tea-age.solutions/2024/01/18/release-of-teascript-0-12-0/ <br>
18+
**What is new in TeaScript 0.13.0?** TeaScript 0.13 comes with Buffer, U8, U64, bit ops, UTF-8 Iterator, hex integrals, MPL-2.0 license and more.<br>
19+
<br>Get all infos in the **latest news** article:<br>
20+
https://tea-age.solutions/2024/03/04/release-of-teascript-0-13-0/ <br>
2121
<br>
2222
Get a very nice overview with the most **impressive highlights** here:<br>
2323
https://tea-age.solutions/teascript/overview-and-highlights/ <br>
@@ -138,7 +138,7 @@ More examples are in the [teascript_demo.cpp](demo/teascript_demo.cpp) of this r
138138
139139
# Example TeaScript Code
140140
141-
(Better syntax highlighting on the TeaScript home page.)
141+
Better syntax highlighting is on the TeaScript home page or in Notepad++ with the provided [SyntaxHighlighting.xml](TeaScript_SyntaxHighlighting_Notepad%2B%2B.xml)
142142
143143
```cpp
144144
def age := 42 // mutable variable of type i64
@@ -198,12 +198,15 @@ call( squared, 3 ) // passing function as parameter. result: 9
198198
call( func (z) { z + z }, 3 ) // passing lambda as parameter. result: 6
199199
```
200200
More impressive highlights on:<br>
201-
https://tea-age.solutions/teascript/overview-and-highlights/
201+
https://tea-age.solutions/teascript/overview-and-highlights/<br>
202+
and in the provided example files in the demo directory: [demo](demo/)
202203

203204

204205
# Supported compiler (tested with)
205206

206-
Visual Studio 2022 (17.2 or newer)
207+
Visual Studio 2022 (17.2 or newer)<br><br>
208+
Depending of the code size it might be required to add the /bigobj flag to the additional settings.<br>
209+
For details see on [StackOverflow](https://stackoverflow.com/questions/15110580/penalty-of-the-msvs-compiler-flag-bigobj)
207210
- Visual Studio 2019 also works (starting from 16.11.14)
208211

209212
g++ 11.3
@@ -286,9 +289,23 @@ Third, usage of the high-level C++ API only. This API will stay backward compati
286289
The high-level API consists of the classes teascript::Engine / teascript::EngineBase, all public getters in teascript::ValueObject as well as everything in Exception.hpp / SourceLocation.hpp and version.h (except if otherwise noted).
287290

288291
# License
289-
The TeaScript C++ Library is 100% Open Source and Free Software and licensed under the GNU AFFERO GENERAL PUBLIC LICENSE Version 3 (AGPL-3.0): see LICENSE.TXT <br>
292+
TeaScript is 100% Open Source and Free Software and licensed under the Mozilla Public License 2.0.<br>
293+
294+
The Mozilla Public License can be read here https://www.mozilla.org/en-US/MPL/2.0/ <br>
295+
296+
This license has the following advantages for TeaScript and for its users:<br>
297+
298+
- it can be linked statically (if all conditions are fulfilled).
299+
- it is explicit compatible with AGPL, GPL and LGPL.
300+
- it is compatible with Apache, MIT, BSD, Boost licenses (and others).
301+
- Larger works (means Applications using TeaScript) can be distributed closed source (or under a compatible license) as long as the conditions are fulfilled.
302+
- For the upcoming module system it means that a new first- or third-party module for TeaScript may use any compatible license like MPL-2.0, (A)GPL, MIT, Apache and so on.
303+
<br>
304+
Many questions regarding the MPL are also answered in the official FAQ: https://www.mozilla.org/en-US/MPL/2.0/FAQ/<br>
305+
306+
If you have further questions regarding the new license don’t hesitate to contact me.
307+
290308

291-
If you cannot or don’t want use this specific open source license, you may ask for a different license.
292309

293310
# Disclaimer
294311
This software is provided “as-is” without any express or implied warranty. In no event shall the author be held liable for any damages arising from the use of this software.

0 commit comments

Comments
 (0)