Skip to content

Commit c6e74ac

Browse files
committed
docs: Updated documentation
- Updated copyright year in LICENSE.md. - Updated README.md to include recent information.
1 parent 420529c commit c6e74ac

File tree

2 files changed

+21
-14
lines changed

2 files changed

+21
-14
lines changed

LICENSE.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
Copyright (C) 2021 Trung Nguyen
1+
Copyright (C) 2021-2023 Trung Nguyen
22

33
Permission is hereby granted, free of charge, to any person obtaining a copy of this software
4-
and associated documentation files (the "Software"), to deal in the Software without restriction,
4+
and associated documentation files (the "Software"), to deal in the Software without restriction,
55
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
6-
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
6+
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
77
subject to the following conditions:
88

9-
The above copyright notice and this permission notice shall be included in all copies or substantial
9+
The above copyright notice and this permission notice shall be included in all copies or substantial
1010
portions of the Software.
1111

12-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
13-
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
12+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
13+
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
1414
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
15-
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
15+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
1616
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# MemoryModule.NET
22

3-
![BuildStatus](https://github.com/trungnt2910/MemoryModule.NET/actions/workflows/ci.yml/badge.svg)
3+
[![Discord Invite](https://dcbadge.vercel.app/api/server/3EB5sKD2Jd?style=flat)](https://discord.gg/3EB5sKD2Jd) 
4+
![BuildStatus](https://github.com/trungnt2910/MemoryModule.NET/actions/workflows/ci.yml/badge.svg)
45
| Package | Version |
56
| ---- | ---- |
67
| Cross platform | [![CrossPlatformShield](https://shields.io/nuget/vpre/MemoryModule)](https://www.nuget.org/packages/MemoryModule) |
78
| Windows | [![WindowsShield](https://shields.io/nuget/vpre/MemoryModule.Compact.Windows)](https://www.nuget.org/packages/MemoryModule.Compact.Windows) |
8-
| Linux | Coming soon |
9-
| MacOS | Coming soon |
9+
| Linux | Coming soon (see the [`Abstractions`](https://github.com/trungnt2910/MemoryModule.NET/tree/dev/trungnt2910/Abstractions) branch) |
10+
| MacOS | Coming soon (see the [`Abstractions`](https://github.com/trungnt2910/MemoryModule.NET/tree/dev/trungnt2910/Abstractions) branch) |
1011

1112
Loads unmanaged libraries right from your embedded resources!
12-
Works on Windows and Linux only, both on .NET Framework and .NET Core (and of course .NET 5.0)
13+
Works on Windows and Linux only, both on .NET Framework and .NET Core (and of course .NET 5.0+)
1314

1415
## Features:
1516
- Load x86 and x64 assemblies, right from the memory. No P/Invoke, no temporary files.
@@ -41,14 +42,20 @@ using MemoryModule;
4142
```
4243

4344

44-
See the DemoApp for more details.
45+
See the DemoApp for more details.
4546

4647
## Packages
4748
- [MemoryModule](https://www.nuget.org/packages/MemoryModule): Cross platform package, with support for x86 and x86_64, Windows and Linux.
4849
- [MemoryModule.Compact.Windows](https://www.nuget.org/packages/MemoryModule.Compact.Windows): Compact module for small, standalone Windows applications.
4950

5051
## Known issues
51-
- Windows: Beware of ~~64-bit~~ `dll` files compiled using g++: https://github.com/fancycode/MemoryModule/issues/108. These files must be compiled using `-static-libgcc` and `-static-libstdc++` to load properly, in both the original C version and this version.
52+
- Windows: Beware of ~~64-bit~~ `dll` files compiled using g++: https://github.com/fancycode/MemoryModule/issues/108. These files must be compiled using `-static-libgcc` and `-static-libstdc++` to load properly, in both the original C version and this version.
5253
- Windows: Resources are not supported.
5354
- Linux: Support is limited. While basic C/C++ libraries, such as `libcurl`, can be properly loaded, MemoryModule.NET may not work with other advanced libraries that contain unknown ELF relocations. If that's the case, please [open an issue](https://github.com/trungnt2910/MemoryModule.NET/issues).
54-
- Linux: As MemoryModule.NET relies on certain `glibc` data structures, it may fail on systems that use beta/custom `glibc` version. Please [open an issue](https://github.com/trungnt2910/MemoryModule.NET/issues) for support.
55+
- Linux: As MemoryModule.NET relies on certain `glibc` data structures, it may fail on systems that use beta/custom `glibc` version. Please [open an issue](https://github.com/trungnt2910/MemoryModule.NET/issues) for support.
56+
57+
## Community
58+
59+
This repo is a part of [Project Reality](https://discord.gg/3EB5sKD2Jd).
60+
61+
Need help using this project? Join me on [Discord](https://discord.gg/3EB5sKD2Jd), and let's find a solution together.

0 commit comments

Comments
 (0)