Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #224

Merged
merged 1 commit into from
Mar 7, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 46 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,50 @@ Differences include:

- Different GUI
- Java-based Apache Tika library for metadata extraction is *NOT* integrated to reduce bloat
- A complete redesign based on .NET Framework API with no regard for maintaining code resemblence to original Java version
- A complete redesign based on .NET Framework API
~~with no regard for maintaining code resemblence to original Java version~~
(See update below)

## Note on compatibility with Java-based [WRECK][wreck]

WRECK.NET started with the original stance that it would be a simplified total
re-implementation in .NET like a separate application without aiming for
feature parity. This is to enable me to focus on rapid development of a working
.NET application with the core functionalities completed.

Much has changed since then. As the prototype Windows Forms application took
shape and began working, I began to become ambitious in trying to make the two
code bases look similar. This is to enable me to update both applications in
future.

Since 10 Jan 2024, I have been incorporating as much reusable logic as
possible, to the point where I was doing a line-by-line porting for the core
classes and methods. In summary, most of the crucial backend and file
processing logic have been ported over.

### Latest status

Update on 7 March 2024

- A `JShim` Java Runtime API emulation layer to mirror call references to
classes and method that wraps around the .NET API
- Majority of codes from the original [WRECK][wreck] has been ported over

What are still missing or different today?

1. Charting of the statistics (given that the UI is not the same)
2. More statistics tracking and reporting
3. Missing file attributes backup, restoration and verification function.

### Future plan and direction

In fact, I have been working on the .NET version and finding it more efficient
and lightweight than the Java version. In all likelihood, I will continue to
focus more on the .NET version going into the future.

The original Java WRECK may become stagnant with no updates or new features.

## Introduction

WRECK.NET is a C#.NET desktop utility tool to *restore the file system timestamp*
*attributes of files using the recorded metadata* if possible and rules /
Expand Down Expand Up @@ -36,4 +79,6 @@ file system, and finally leaving the files ready for archival and preservation.
![WRECK>NET CLI](../../wiki/assets/images/wreck-cli.png)

For more information, see the [Wiki](../../wiki/Home).

[wreck]: https://github.com/gyk4j/wreck