diff --git a/AGENTS.md b/AGENTS.md index 047be5dbb..a148385fd 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -809,6 +809,7 @@ are short, and a stale one is worse than none — if you change what a file desc | [`Docs/Usage/Exceptions.md`](Sources/AngouriMath/Docs/Usage/Exceptions.md) | the exception hierarchy under `AngouriMathBaseException` | | [`Docs/Usage/Comparison.md`](Sources/AngouriMath/Docs/Usage/Comparison.md) | how we measure against Math.NET Symbolics, Symbolism and SymPy, with the versions and what each comparison does not establish | | [`Docs/References.md`](Sources/AngouriMath/Docs/References.md) | the books, papers, corpora and reference works the code and its tests draw on, with the link and what each is used for. Add a work there when it is first cited | +| [`Docs/Acknowledgements.md`](Sources/AngouriMath/Docs/Acknowledgements.md) and [`Docs/Articles.md`](Sources/AngouriMath/Docs/Articles.md) | the projects AngouriMath is built with, and the maintainers' articles about it, moved from the archived AngouriMathLab | | [`Docs/Contributing/`](Sources/AngouriMath/Docs/Contributing/README.md) | the index of the contributor docs | | [`Contributing/General.md`](Sources/AngouriMath/Docs/Contributing/General.md) | the `Entity` hierarchy, in a paragraph | | [`Contributing/AddingNode.cs`](Sources/AngouriMath/Docs/Contributing/AddingNode.cs) | every place a new node has to be taught about. Read it *before* adding one | diff --git a/README.md b/README.md index e25f2b8d8..2adf0cd09 100644 --- a/README.md +++ b/README.md @@ -138,7 +138,7 @@ cd AngouriMath/Sources/Terminal/AngouriMath.Terminal dotnet run -c Release ``` -See the online [Jupyter notebook](https://mybinder.org/v2/gh/asc-community/AngouriMathLab/try?filepath=HelloBook.AngouriMath.Interactive.ipynb) on +See the [Jupyter notebook](./Sources/Samples/Interactive.Sample.ipynb) on how to use the F# API of AngouriMath. Note, that the C# API is still available via `open AngouriMath` command, then you can call the main library's methods. @@ -146,7 +146,8 @@ See its [source folder](./Sources/Terminal). ### More -Read more about using AngouriMath for research on [the website](https://am.angouri.org/research). +Read more about using AngouriMath for research on [the website](https://am.angouri.org/research), +and in [the maintainers' articles](./Sources/AngouriMath/Docs/Articles.md). @@ -547,3 +548,5 @@ to the project. Aside from volunteer donations, you can help developing the proj The project is open source, but can be used in closed commercial projects. There is no restriction on it with the only requirement to keep the MIT license with all distributives of AngouriMath. +The projects AngouriMath is built with are thanked in [Acknowledgements](./Sources/AngouriMath/Docs/Acknowledgements.md). + diff --git a/Sources/AngouriMath/Docs/Acknowledgements.md b/Sources/AngouriMath/Docs/Acknowledgements.md new file mode 100644 index 000000000..a915f3f0a --- /dev/null +++ b/Sources/AngouriMath/Docs/Acknowledgements.md @@ -0,0 +1,27 @@ +# Projects we are thankful to + +No project today stands alone. Moved from the archived +[AngouriMathLab](https://github.com/asc-community/AngouriMathLab) repository +([#1689](https://github.com/asc-community/AngouriMath/issues/1689)). The books, papers and corpora +the code draws on are in [References](References.md). + +We thank: +- GitHub, for a great hosting and communication platform +- [.NET Runtime](https://github.com/dotnet/runtime), and Native AOT in it +- [.NET SDK](https://github.com/dotnet/sdk) +- [Roslyn compiler](https://github.com/dotnet/roslyn) +- [Visual Studio](https://visualstudio.microsoft.com) +- [F# compiler and core library](https://github.com/dotnet/fsharp) +- [.NET Interactive](https://github.com/dotnet/interactive) +- [Git](https://github.com/git/git) +- [CMake](https://github.com/Kitware/CMake) +- [Jupyter notebooks](https://github.com/jupyter/notebook) +- [Jupyter Binder](https://github.com/jupyterhub/binderhub) +- [Numbers](https://github.com/peteroupc/Numbers), for great arithmetic +- [Nullable](https://github.com/manuelroemer/Nullable) +- [Antlr](https://github.com/antlr/antlr4) +- [Octicons](https://iconify.design/icon-sets/octicon/) +- [flaticon](https://www.flaticon.com), for great icons made by Freepik +- [Discord](https://discord.com/invite/YWJEX7a), for communication +- all the free and open-source [dependencies](https://www.nuget.org/packages/AngouriMath) we have +- JetBrains, for IDEs diff --git a/Sources/AngouriMath/Docs/Articles.md b/Sources/AngouriMath/Docs/Articles.md new file mode 100644 index 000000000..642298aa7 --- /dev/null +++ b/Sources/AngouriMath/Docs/Articles.md @@ -0,0 +1,11 @@ +# Articles + +Articles by the maintainers about AngouriMath. Moved from the archived +[AngouriMathLab](https://github.com/asc-community/AngouriMathLab) repository +([#1689](https://github.com/asc-community/AngouriMath/issues/1689)). + +1. [Symbolic algebra in C#](https://habr.com/en/post/486496/) +2. [Jupyter in .NET](https://habr.com/en/post/528816/) +3. [Math in Jupyter for .NET](https://www.reddit.com/r/dotnet/comments/jv7qqt/net_jupyter_math_looks_awesome/) +4. [Lazy properties in C#](https://habr.com/en/post/545936/) +5. [Compilation of symbolic expressions](https://habr.com/en/post/546926/) diff --git a/Sources/Terminal/readme.md b/Sources/Terminal/readme.md index bf06bc363..d6d31e860 100644 --- a/Sources/Terminal/readme.md +++ b/Sources/Terminal/readme.md @@ -5,7 +5,7 @@ This is desktop-targeted convenient CLI for AngouriMath. The idea is to provide convenient easy-to-use and lightweight terminal to run some basic calculations in it. -The interface language is F#. If you're not familiar with it, check out a [Jupyter notebook](https://mybinder.org/v2/gh/asc-community/AngouriMathLab/try?filepath=HelloBook.AngouriMath.Interactive.ipynb), +The interface language is F#. If you're not familiar with it, check out a [Jupyter notebook](../Samples/Interactive.Sample.ipynb), an interactive graphical notebook to working with AngouriMath. ![gif](https://raw.githubusercontent.com/asc-community/AngouriMath/terminal-as-global-tool/Sources/Terminal/terminal.gif)