From afadfcea9634154e2fc88c15cb4c96a53f6fc826 Mon Sep 17 00:00:00 2001 From: gyk4j <147011991+gyk4j@users.noreply.github.com> Date: Tue, 13 Aug 2024 13:30:27 +0800 Subject: [PATCH] Update README --- README.md | 73 ++++++++++++++++++++----------------------------------- 1 file changed, 26 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 368ea2e..10f6ef5 100644 --- a/README.md +++ b/README.md @@ -2,54 +2,29 @@ # A simplified C#.NET implementation of WRECK. -Not a direct port, but a rewrite. +Not a direct port, but a rewrite of [WRECK][wreck], a +Java tool for restoring file timestamps using embedded metadata, and heuristic +rules based on file naming convention, personal habits and other methods of +estimating a more accurate timestamp. -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~~ - (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 +It is an essential tool when doing file backup and preservation to ensure that +file creation, modification and access timestamps are as accurate as possible. -Update on 7 March 2024 +Differences include: -- 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 +1. Windows Form GUI, not Java Swing +2. Exclusion of Java-based Apache Tika library for metadata extraction to reduce + bloat +3. A complete redesign based on [.NET Framework][dotnetfx] API and + [Windows Forms][winforms] +4. Charting of the statistics (given that the UI is not the same) +5. No statistics tracking and reporting +6. Missing file attributes backup, restoration and verification function. -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. +![WRECK.NET GUI](../../wiki/assets/images/wreck-gui.png) +![WRECK>NET CLI](../../wiki/assets/images/wreck-cli.png) -The original Java WRECK may become stagnant with no updates or new features. +For more information, see the [Wiki](../../wiki/Home). ## Introduction @@ -75,10 +50,14 @@ photos, MP4 videos, MP3 audio) using a few libraries to maximize success in metadata extraction, work out the appropriate timestamps, correct them in the file system, and finally leaving the files ready for archival and preservation. -![WRECK.NET GUI](../../wiki/assets/images/wreck-gui.png) -![WRECK>NET CLI](../../wiki/assets/images/wreck-cli.png) +### Future plan and direction -For more information, see the [Wiki](../../wiki/Home). +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. [wreck]: https://github.com/gyk4j/wreck - +[dotnetfx]: https://en.wikipedia.org/wiki/.NET_Framework +[winforms]: https://en.wikipedia.org/wiki/Windows_Forms