Skip to content

Commit

Permalink
docs: readme and news update
Browse files Browse the repository at this point in the history
  • Loading branch information
abelcheung committed Nov 30, 2023
1 parent b1db037 commit b7c8f98
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 47 deletions.
27 changes: 15 additions & 12 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,24 @@
## 0.8.0
#### Breaking Change
## (Upcoming) 0.8.0

### Breaking Change
- As a result of changes below, package maintainers need to rewrite their package files. See [compile instructions](https://github.com/abelcheung/rifiuti2/wiki/Compile-From-Source) and [GitHub workflow file](.github/workflows/check.yml) for reference.
- (#21) Adopts CMake as build system, and drop Autoconf/Automake completely.
- Gettext support is removed, its m4 macro versioning is placing a burden on maintainers and packagers
- Same for the translation. No contribution so far, probably this is unneeded
- ([#21](https://github.com/abelcheung/rifiuti2/issues/21)) Adopts CMake as build system, and drop Autoconf/Automake completely. Document files have been restructured as well.
- ([#18](https://github.com/abelcheung/rifiuti2/issues/18)) Gettext support is removed, its m4 macro versioning is placing a burden on maintainers and packagers.
- Same for the translation. No contribution so far, probably this is unneeded.
- 64 bit Windows binary only supports Windows ≥ 8.1
- for earlier 64-bit Windows versions, use 32 bit binary
- for earlier (7, 8.0) x64 Windows, use 32 bit binary

#### Feature
### Feature

- (#3) Implement live system inspection on Windows
- ([#3](https://github.com/abelcheung/rifiuti2/issues/3)) Implement live system inspection on Windows
- ([#32](https://github.com/abelcheung/rifiuti2/issues/32)) `$Recycle.bin` also shows extra field like old `INFO2` files do, displaying whether some trashed entries have been restored, leaving only the index file present inside `$Recycle.bin`

#### Bug Fix and minor change
### Bug Fix and minor change

- (#28) Fix crash on big endian platform due to incorrect string length check
- (#19) Avoid printing garbage for stderr under Windows command prompt
- (#22) Manpage is retired, referring users to GitHub repository and online docs
- ([#28](https://github.com/abelcheung/rifiuti2/issues/28)) Fix crash on big endian platform due to incorrect string length check
- ([#19](https://github.com/abelcheung/rifiuti2/issues/19), [#34](https://github.com/abelcheung/rifiuti2/issues/34)) Avoid printing garbage under Windows command prompt
- ([#22](https://github.com/abelcheung/rifiuti2/issues/22)) Manpage is retired, referring users to GitHub repository and online docs
- (Variation of [#17](https://github.com/abelcheung/rifiuti2/issues/17)) Program name shown as `(null)` in Windows GUI help dialog

## 0.7.0
#### Feature Addition
Expand Down
46 changes: 11 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,19 @@ and size of deleted files and whether the trashed files have been
permanently removed.

For those interested in what it does, and what functionality it
provides, please [check out official site][1] for more info.
Latest features and changes can be found in [NEWS file](NEWS.md).
provides, please [check out official site][site] for more info.

[1]: https://abelcheung.github.io/rifiuti2
[site]: https://abelcheung.github.io/rifiuti2

## Special notes

Latest features and changes can be found in [NEWS file](NEWS.md).

### (Upcoming) 0.8.0

- Windows binaries will be published via MSYS2 GitHub workflow.
- Windows binaries will be published via [MSYS2 GitHub workflow](https://github.com/msys2/setup-msys2).
- Package maintainers would need to rewrite their package files,
in light of multiple renovation:
- document restructuring [#22](https://github.com/abelcheung/rifiuti2/issues/22)
- CMake migration, retiring autotools [#21](https://github.com/abelcheung/rifiuti2/issues/21).
- Gettext removal [#18](https://github.com/abelcheung/rifiuti2/issues/18)

### 0.7.0

Systems supporting UTF-8 encoding is mandatory, except on Windows
Command Prompt. File output in Windows is also in UTF-8.

- UTF-8 locale is pretty much standard for Linux and macOS these years.
- On Windows front, there are already many featureful text editors
capable of opening UTF-8 unicode text files.
- As a result, `-8` option is obsolete and no more affects output in any way.
in light of multiple renovations: [CMake migration](https://github.com/abelcheung/rifiuti2/issues/21), [gettext removal](https://github.com/abelcheung/rifiuti2/issues/18), document restructuring etc.


## Usage
Expand Down Expand Up @@ -64,31 +52,19 @@ More compatibility fix for other architectures welcome.

### Windows
Windows binaries are officially provided
[on Github release page][rel].
[on Github release page][rel]. Some info for ancient Windows
version are [available on wiki][wiki_pkg_win].

[rel]: https://github.com/abelcheung/rifiuti2/releases/

For various technical reasons, users of very ancient Windows
platforms may not be able to use latest `rifiuti2` on their OS.
For following versions, get their corresponding `rifiuti2`
version instead of latest one:

Windows | Latest supported version
:------------------- | :--------------------------
XP or Server 2003 | [0.6.1][rel_061]
Vista or Server 2008 | [0.7.0][rel_070]
7 or above | [all][rel_latest]

[rel_061]: https://github.com/abelcheung/rifiuti2/releases/tag/0.6.1
[rel_070]: https://github.com/abelcheung/rifiuti2/releases/tag/0.7.0
[rel_latest]: https://github.com/abelcheung/rifiuti2/releases/latest
[wiki_pkg_win]: https://github.com/abelcheung/rifiuti2/wiki/Packages#packages-for-windows

### Unix packages

Most Linux and FreeBSD users can use pre-packaged software for
convenience. Check out [the status here][unx_pkg].
convenience. Check out [the status here][wiki_pkg].

[unx_pkg]: https://github.com/abelcheung/rifiuti2/wiki/Unix-Packages
[wiki_pkg]: https://github.com/abelcheung/rifiuti2/wiki/Packages#packages-for-linux-and-bsd

### Others
For OS where `rifiuti2` is not readily available, it is always
Expand Down

0 comments on commit b7c8f98

Please sign in to comment.