Skip to content

Commit afadfce

Browse files
committed
Update README
1 parent 200d07d commit afadfce

File tree

1 file changed

+26
-47
lines changed

1 file changed

+26
-47
lines changed

README.md

+26-47
Original file line numberDiff line numberDiff line change
@@ -2,54 +2,29 @@
22

33
# A simplified C#.NET implementation of WRECK.
44

5-
Not a direct port, but a rewrite.
5+
Not a direct port, but a rewrite of [WRECK][wreck], a
6+
Java tool for restoring file timestamps using embedded metadata, and heuristic
7+
rules based on file naming convention, personal habits and other methods of
8+
estimating a more accurate timestamp.
69

7-
Differences include:
8-
9-
- Different GUI
10-
- Java-based Apache Tika library for metadata extraction is *NOT* integrated to reduce bloat
11-
- A complete redesign based on .NET Framework API
12-
~~with no regard for maintaining code resemblence to original Java version~~
13-
(See update below)
14-
15-
## Note on compatibility with Java-based [WRECK][wreck]
16-
17-
WRECK.NET started with the original stance that it would be a simplified total
18-
re-implementation in .NET like a separate application without aiming for
19-
feature parity. This is to enable me to focus on rapid development of a working
20-
.NET application with the core functionalities completed.
21-
22-
Much has changed since then. As the prototype Windows Forms application took
23-
shape and began working, I began to become ambitious in trying to make the two
24-
code bases look similar. This is to enable me to update both applications in
25-
future.
26-
27-
Since 10 Jan 2024, I have been incorporating as much reusable logic as
28-
possible, to the point where I was doing a line-by-line porting for the core
29-
classes and methods. In summary, most of the crucial backend and file
30-
processing logic have been ported over.
31-
32-
### Latest status
10+
It is an essential tool when doing file backup and preservation to ensure that
11+
file creation, modification and access timestamps are as accurate as possible.
3312

34-
Update on 7 March 2024
13+
Differences include:
3514

36-
- A `JShim` Java Runtime API emulation layer to mirror call references to
37-
classes and method that wraps around the .NET API
38-
- Majority of codes from the original [WRECK][wreck] has been ported over
15+
1. Windows Form GUI, not Java Swing
16+
2. Exclusion of Java-based Apache Tika library for metadata extraction to reduce
17+
bloat
18+
3. A complete redesign based on [.NET Framework][dotnetfx] API and
19+
[Windows Forms][winforms]
20+
4. Charting of the statistics (given that the UI is not the same)
21+
5. No statistics tracking and reporting
22+
6. Missing file attributes backup, restoration and verification function.
3923

40-
What are still missing or different today?
41-
42-
1. Charting of the statistics (given that the UI is not the same)
43-
2. More statistics tracking and reporting
44-
3. Missing file attributes backup, restoration and verification function.
45-
46-
### Future plan and direction
47-
48-
In fact, I have been working on the .NET version and finding it more efficient
49-
and lightweight than the Java version. In all likelihood, I will continue to
50-
focus more on the .NET version going into the future.
24+
![WRECK.NET GUI](../../wiki/assets/images/wreck-gui.png)
25+
![WRECK>NET CLI](../../wiki/assets/images/wreck-cli.png)
5126

52-
The original Java WRECK may become stagnant with no updates or new features.
27+
For more information, see the [Wiki](../../wiki/Home).
5328

5429
## Introduction
5530

@@ -75,10 +50,14 @@ photos, MP4 videos, MP3 audio) using a few libraries to maximize success in
7550
metadata extraction, work out the appropriate timestamps, correct them in the
7651
file system, and finally leaving the files ready for archival and preservation.
7752

78-
![WRECK.NET GUI](../../wiki/assets/images/wreck-gui.png)
79-
![WRECK>NET CLI](../../wiki/assets/images/wreck-cli.png)
53+
### Future plan and direction
8054

81-
For more information, see the [Wiki](../../wiki/Home).
55+
In fact, I have been working on the .NET version and finding it more efficient
56+
and lightweight than the Java version. In all likelihood, I will continue to
57+
focus more on the .NET version going into the future.
58+
59+
The original Java WRECK may become stagnant with no updates or new features.
8260

8361
[wreck]: https://github.com/gyk4j/wreck
84-
62+
[dotnetfx]: https://en.wikipedia.org/wiki/.NET_Framework
63+
[winforms]: https://en.wikipedia.org/wiki/Windows_Forms

0 commit comments

Comments
 (0)