Skip to content

Commit

Permalink
Minor Docs Tweaks (#435)
Browse files Browse the repository at this point in the history
  • Loading branch information
sirredbeard authored May 28, 2024
1 parent 53f9898 commit c51f250
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 31 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@

- Visual Studio 2022 or later.
- You also need install ARM64 components (MSVC Toolchain and ATL/MFC) if you
want to compile ARM64 version of NanaZip.
want to compile the ARM64 version of NanaZip.
- Windows 11 SDK or later.
- You also need install ARM64 components if you want to compile ARM64 version
- You also need to install ARM64 components if you want to compile the ARM64 version
of NanaZip.

#### How to build all targets of NanaZip
Expand Down
18 changes: 14 additions & 4 deletions Documents/Privacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,22 @@
## Information collected
NanaZip does not collect any information. However it does provide you access to
files and folders on your file system. Additionally, the Windows Store and
Windows app host collects data on usage, for example, who bought/used the app
Windows App Host collect data on usage, for example, who bought/used the app
and crash reports. If you open any files or links in the app that go to other
websites you will need to look at their privacy policy.
websites you will need to look at their privacy policy.

## Sponsored edition
Due to the Microsoft Store Licensing API implementation, you will find NanaZip
will try to access the Internet beginning with NanaZip 3.0 because NanaZip
needs to use that to check the Sponsor Edition addon licensing status.

For optimizing the user experience, NanaZip will only check the Sponsor
Edition addon licensing status at the first time your launch NanaZip File
Manager. You can click the sponsor button if you want to refresh the status
after you have purchased or redeemed the Sponsor Edition addon.

## Use of information
No information is collected or shared over the wire. We reserve the right to
No other data is collected or shared online. We reserve the right to
make changes to this policy. Any changes to this policy will be updated.

## Last updated: Sep 25, 2021
## Last updated: May 28, 2024
16 changes: 8 additions & 8 deletions Documents/SponsorEdition.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# NanaZip Sponsor Edition

NanaZip provides $99.99 Sponsor Edition addon to the Microsoft Store for attract
more sponsors and contributors.
NanaZip provides a $99.99 USD Sponsor Edition addon to the Microsoft Store to
attract more sponsors and contributors.

It's free for NanaZip source code repository contributors and NanaZip sponsors
who sponsored before March 30, 2024.
Expand All @@ -16,19 +16,19 @@ stable version of NanaZip's toolbar like the Visual Studio administrator mode.

## Purpose

Hope every NanaZip users happier than before. Here are some imagination
examples.
We hope every NanaZip user is happier than before. Here is why we offer a
sponsored version:

- Most users: We are happy with using a $99.99 product freely without feature
differences.
- Contributors: We want to show "Appreciate your sponsorship" button to
others. It's free because we are the contributors. Contribute it if you want
to get that free.
- Sponsors: We can show "Appreciate your sponsorship" button to others
because we deserve that.
- The author of NanaZip, Kenji Mouri: Finally, NanaZip has the price. Nobody
- Sponsors: You can show "Appreciate your sponsorship" button to others
because sponsors deserve that.
- The author of NanaZip, Kenji Mouri: Finally, NanaZip has a price. Nobody
will think this is a worthless product. Efforts from contributors and I should
have a reference price even NanaZip is a fully free and open source project.
have value even NanaZip is a fully free and open source project.

## Notes for NanaZip source code repository contributors

Expand Down
34 changes: 17 additions & 17 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ experience, forked from the source code of well-known open source file archiver
7-Zip.

**All kinds of contributions will be appreciated. All suggestions, pull
requests and issues are welcome.**
requests, and issues are welcome.**

If you want to sponsor the development of NanaZip, please read the document of
[NanaZip Sponsor Edition](Documents/SponsorEdition.md). It's free for all
Expand All @@ -43,15 +43,15 @@ Kenji Mouri

- Inherit all features from 7-Zip 24.05.
- Support the dark mode for all GUI components.
- Support the Mica effect to the main window. You will enjoy the full window
- Support the Mica effect on the main window. You will enjoy the full window
immersive Mica for all GUI components if you are using dark mode with HDR
disabled.
- Packaging with MSIX for modern deployment experience.
- Support the context menu in Windows 10/11 File Explorer.
- Enable NSIS script decompiling support for the NSIS archives. (Merged from
[7-Zip NSIS branch](https://github.com/myfreeer/7z-build-nsis).)
- Provide 7-Zip execution alias for helping users to migrate to NanaZip.
- Support the Brotli, Fast-LZMA2, Lizard, LZ4, LZ5 and Zstandard codecs. (Merged
- Support the Brotli, Fast-LZMA2, Lizard, LZ4, LZ5, and Zstandard codecs. (Merged
from [7-Zip ZS branch](https://github.com/mcmilk/7-Zip-zstd).)
- Support the Per-Monitor DPI-Aware for all GUI components.
- Support the i18n for GUI edition of Self Extracting Executable.
Expand All @@ -60,7 +60,7 @@ Kenji Mouri
GOST R 34.11-94 CryptoPro, GOST R 34.11-2012 256, GOST R 34.11-2012 512,
HAS-160, RIPEMD-160, SHA-224, SHA3-224, SHA3-256, SHA3-384, SHA3-512,
Snefru-128, Snefru-256, Tiger, Tiger2, TTH, Whirlpool), xxHash (XXH3_64bits,
XXH3_128bits) and GmSSL (SM3).
XXH3_128bits), and GmSSL (SM3).
- Enable Control Flow Guard (CFG) to all target binaries for mitigating ROP
attacks.
- Mark all x86 and x64 target binaries as compatible with Control-flow
Expand All @@ -82,7 +82,7 @@ NanaZip Classic. Here are the differences between them.
- NanaZip
- Only 64-Bit support.
- Only MSIX packaged version.
- Support the context menu in Windows 10/11 File Explorer.
- Support for the context menu in Windows 10/11 File Explorer.
- Only support Windows 10 Version 2004 (Build 19041) or later.
- Have XAML-based GUI and VT-based CLI.

Expand All @@ -107,17 +107,17 @@ NanaZip Classic. Here are the differences between them.
- Supported OS: Windows Vista RTM (Build 6000.16386) or later
- Supported Platforms: x86 (32-bit and 64-bit) and ARM (64-bit)

We only choose Windows as the major platform for the NanaZip project supported
We chose Windows as the major platform for the NanaZip project supported
because Windows has maintained a good and proven ABI and compatibility, and
stands out in the whole history. But we also care about the non-Windows
stands out in the history of computing. But we also care about the non-Windows
platform. Here are the policy for non-Windows platform support:

- The modern flavor of NanaZip won't support non-Windows unless someguys ported
- The modern flavor of NanaZip won't support non-Windows unless someone ported
WinRT XAML to POSIX. So, non-Windows support policy is only for NanaZip Core
and NanaZip Classic.
- The developer team will try best to support Wine which has the Windows Vista
or later feature level. Currenly tested simply under Wine 9.x.
- We don't support the ReactOS and its derivatives because they are too hard to
- We don't support ReactOS and its derivatives because they are too hard to
support. But testing under the ReactOS and its derivatives may be interesting.

## Download and Installation
Expand All @@ -128,8 +128,8 @@ Here are some available installation methods for NanaZip.

This is the recommended way to install NanaZip.

Search and install `NanaZip` in Windows Store for stable release, and `NanaZip
Preview` for preview release.
Search and install `NanaZip` in Windows Store for the stable release, and `NanaZip
Preview` for the preview release.

Also, you can also click the Microsoft Store link you needed.

Expand All @@ -147,7 +147,7 @@ administrator.

> PowerShell -NoLogo -NoProfile -NonInteractive -InputFormat None -ExecutionPolicy Bypass Add-AppxPackage -DeferRegistrationWhenPackagesAreInUse -ForceUpdateFromAnyVersion -Path `The path of the MSIX package`
P.S. All needed dependencies are included in the MSIX Package of NanaZip
Note: All needed dependencies are included in the MSIX Package of NanaZip
because we known that it's very difficult for users who do not have access to
the store to get our dependency packages, and we want to be robust and
deployable everywhere.
Expand All @@ -165,7 +165,7 @@ as administrator instead.
For more information, please read documents for [PowerShell](https://learn.microsoft.com/en-us/powershell/module/dism/add-appxprovisionedpackage?view=windowsserver2022-ps) and
[DISM](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/dism-app-package--appx-or-appxbundle--servicing-command-line-options?view=windows-11)

P.S. Due to the policy from Microsoft Store, you need to run NanaZip with the
Note: Due to the policy from Microsoft Store, you need to run NanaZip with the
internet connection at the first time for getting the license if you install
NanaZip without the internet connection, otherwise Windows won't launch NanaZip
properly.
Expand All @@ -191,12 +191,12 @@ the following command in the PowerShell which is run as administrator.
- Due to the Microsoft Store limitations, NanaZip 1.2 and later won't support
languages not mentioned in
https://docs.microsoft.com/en-us/windows/uwp/publish/supported-languages.
- If you turn off the Windows Firewall, you may fail to install NanaZip.
- If you turn off the Windows Firewall, NanaZip may fail to install.
(https://github.com/M2Team/NanaZip/issues/204)
(https://github.com/microsoft/terminal/issues/12269)
- Due to the System Settings APP limitations, only starting with Windows 11+
(Build 22000.1817+ & 22621.1555+), you can launch directly to the settings
page of file association for NanaZip.
- Due to the System Settings limitations, starting with Windows 11+
(Build 22000.1817+ & 22621.1555+), you can launch directly to the Settings
page for file association for NanaZip.
(https://learn.microsoft.com/en-us/windows/uwp/launch-resume/launch-default-apps-settings)
- Due to the Microsoft Store Licensing API implementation, you will find NanaZip
will try to access the Internet beginning with NanaZip 3.0 because NanaZip
Expand Down

0 comments on commit c51f250

Please sign in to comment.