Skip to content

README.md

Latest commit

 

History

History
65 lines (46 loc) · 2.45 KB

README.md

File metadata and controls

65 lines (46 loc) · 2.45 KB

IronFamily.FileEngine

CI License: MIT Stage: Active Development Latest Tag Wiki

Monorepo for IronFamily file and data engines, native components, and supporting tools.

Status: this project is actively under development and still changing.

What is in this repo

  • libs/ .NET and native libraries (IronConfig, ILog, IUPD, related components)
  • native/ native code and low-level integration assets
  • tools/ development and benchmarking tools
  • vectors/ canonical test vectors
  • docs/ technical documentation and specifications

Quick start

dotnet build -c Release libs/ironconfig-dotnet/IronConfig.sln
dotnet test  -c Release libs/ironconfig-dotnet/IronConfig.sln

Native (if configured in your environment):

cmake -S native -B native/build
cmake --build native/build --config Release
ctest --test-dir native/build -C Release --output-on-failure

Performance

Overview benchmark:

dotnet run -c Release --project tools/megabench/MegaBench.csproj -- bench-overview --datasets 100KB,1MB --label current

Reference benchmark documents:

  • artifacts/bench/megabench_metrics/overview/overview_mega_all_20260325_analysis.md
  • artifacts/bench/megabench_metrics/overview/overview_mega_all_20260325_ranking.csv

Repository standards

  • Clean root, no ad-hoc logs/scripts in repository root
  • Canonical vectors live under vectors/
  • CI gates are required before merging
  • Documentation should stay aligned with code and released behavior

Wiki

Wiki content source is maintained under docs/wiki/. Use this directory as source-of-truth for future GitHub Wiki sync.

Release