Update README.md
This commit is contained in:
53
README.md
53
README.md
@ -1,32 +1,61 @@
|
||||
# LNXCORE
|
||||
***
|
||||
|
||||
Leenkx Core for the LNXSDK - Leenkx Full Stack Torrent Based Software Development Kit.
|
||||
Leenkx Runtime for the Full Stack Software Development Kit.
|
||||
|
||||
Based on these projects:
|
||||
[Krom](https://github.com/Kode/Krom)
|
||||
[Kinc](https://github.com/Kode/Kinc)
|
||||
[V8](https://github.com/v8/v8)
|
||||
[uWS](https://github.com/uNetworking/uWebSockets)
|
||||
|
||||
Based on [Krom](https://github.com/Kode/Krom). Powered by [Kinc](https://github.com/Kode/Kinc).
|
||||
|
||||
```bash
|
||||
git clone --recursive https://dev.leenkx.com/LeenkxTeam/LNXCORE
|
||||
cd LNXCORE
|
||||
```
|
||||
|
||||
**Windows**
|
||||
```bash
|
||||
# Unpack `v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB)
|
||||
Kinc/make -g direct3d11
|
||||
# Open generated Visual Studio project at `build\Krom.sln`
|
||||
# Build for x64 & release
|
||||
```
|
||||
|
||||
**Linux**
|
||||
```bash
|
||||
Kinc/make -g opengl --compiler clang --compile
|
||||
cd Deployment
|
||||
strip Krom
|
||||
strip Leenkx-Core
|
||||
```
|
||||
|
||||
**Windows**
|
||||
```bash
|
||||
# Unpack `v8\libraries\win32\release\v8_monolith.7z` using 7-Zip - Extract Here (exceeds 100MB)
|
||||
Kinc/make -g direct3d11
|
||||
# Open generated Visual Studio project at `build\Leenkx-Core.sln`
|
||||
# Build for x64 & release
|
||||
```
|
||||
|
||||
**macOS**
|
||||
```bash
|
||||
Kinc/make -g metal
|
||||
# Open generated Xcode project at `build/Krom.xcodeproj`
|
||||
# Open generated Xcode project at `build/Leenkx-Core.xcodeproj`
|
||||
# Build
|
||||
```
|
||||
|
||||
|
||||
## Networking Setup Instructions
|
||||
***
|
||||
*Native websockets are included in the build with the networking flag enabled while the uWS flag and implementation files are experimental.
|
||||
|
||||
To get the uWS files to work proceed with the following:
|
||||
#### - Add uWebSockets as a submodule to your project:
|
||||
|
||||
```bash
|
||||
git submodule add https://github.com/uNetworking/uWebSockets.git
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
### Fastest WebSocket library available (~8M connections possible)
|
||||
- **Zero-copy**: Minimal data copying between C++ and JavaScript
|
||||
- **Event-driven**: Non-blocking, asynchronous operations
|
||||
- **Cross-platform**: Works on Windows, macOS, and Linux
|
||||
- **Small footprint**: Minimal memory overhead per connection
|
||||
- **Efficient callbacks**: Direct V8 bindings without intermediate layers
|
||||
- **Resource cleanup**: Automatic cleanup of closed connections
|
||||
|
Reference in New Issue
Block a user