From 4e0dd214955aec436f97c28bfc29db1b814f4c73 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Tue, 25 Mar 2025 22:22:49 +0000 Subject: [PATCH] Add more warnings to the readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 601b878f..d6d94549 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,25 @@ This is an **experimental** reimplementation of [libloot](https://github.com/loot/libloot) using Rust instead of C++, that should match libloot v0.25.5. +See the `cxx` and `pyo3` subdirectories for C++ and Python wrappers respectively. + +Expect: + +- bugs +- Git history to be rewritten without warning +- this Git repository to disappear without warning + +If this experiment is successful it will probably end up being merged into the libloot repository, replacing much of its contents. + +## Outstanding issues + +- I haven't yet attempted to build it on Linux. +- There is no CI. +- It relies on some unreleased improvements to the Rust APIs of libloadorder and loot-condition-interpreter. +- It uses more memory than the C++ implementation, and I haven't finished investigating why or if there's anything I can/should do about that. +- I'm not very confident about the YAML emitter I've written, it needs more test cases and probably another review against the spec. +- The `saphyr` and `saphyr-parser` dependencies that are used to parse metadata YAML have some rough edges, and compared to the other dependencies they are relatively new, unpopular libraries that are maintained by people I've not heard of before, so they may be relatively risky dependencies. + ## Build Make sure you have [Rust](https://www.rust-lang.org/) installed.