Skip to content
Merged
Show file tree
Hide file tree
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
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
root = true

[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4

[*.{xaml,csproj,props,slnx,json,yml,yaml,svg}]
indent_size = 2

[*.md]
trim_trailing_whitespace = false
3 changes: 3 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* text=auto eol=lf
*.ico binary
*.png binary
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Bug report
about: Something went wrong while using ZipXP
labels: bug
---

**What happened?**

**What did you expect?**

**Steps to reproduce**

**Environment**
- ZipXP version or git commit:
- Windows version:
- Drive/NTFS details if relevant (cluster size, SSD/HDD):

**Diagnostics**
Use Activity > Copy diagnostics and paste it here. Remove any paths you do not want to share.
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Feature request
about: Suggest an improvement
labels: enhancement
---

**What problem would this solve?**

**What would you like ZipXP to do?**
6 changes: 6 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
## What and why

## How it was checked
- [ ] `dotnet build ZipXP.slnx` has no warnings
- [ ] `scripts/check.ps1` passes (or explain why not)
- [ ] User-facing text and docs updated if behaviour changed
23 changes: 23 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: build

on:
push:
branches: [main]
pull_request:

permissions:
contents: read

jobs:
build-and-check:
runs-on: windows-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v4
- uses: actions/setup-dotnet@v4
with:
dotnet-version: 10.0.x
- name: Build
run: dotnet build ZipXP.slnx --nologo -warnaserror
- name: Run checks
run: dotnet run --project tests/ZipXP.Checks/ZipXP.Checks.csproj --no-build
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
**/obj/
.vs/
*.user
gui/artifacts/
storage-manager/artifacts/
artifacts/
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Changelog

All notable changes to ZipXP are recorded here. The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).

## [Unreleased]

### Known issues
- After decompression, the measured allocation can be read before the file handle is closed, which overstates growth for some non-aligned file sizes and can show a small negative savings total. Tracked in [#2](https://github.com/kiranscript/zipxp/issues/2); details in [docs/validation.md](docs/validation.md).

### Changed
- Repository reorganised into `src/`, `tests/`, `scripts/` and `docs/`; projects renamed from `StorageManager.*` to `ZipXP.*`.
- The window, tray icon and sidebar now say "ZipXP" instead of "ZipXP Storage Manager".
- README rewritten as a product front page; the technical detail moved to `docs/`.
- Added MIT license, solution file, `.editorconfig`, CI workflow and issue/PR templates.

### Unchanged on purpose
- Data folder, startup entry, single-instance name, executable name and install folder keep their `StorageManager` identifiers so existing installs and saved policies continue to work.

## [0.2.0] (pre-release)

### Added
- Selective, policy-driven NTFS compression of managed folders: read-only analysis first, then optional automatic compression of existing, new, copied-in and changed files.
- Persistent single-file-at-a-time queue with retry/backoff, quiet periods, cooldowns, schedules, battery, CPU and free-space gates, and crash recovery.
- System-tray worker, optional start at sign-in, and **Restore original size** decompression.
- Overview, managed folders, storage insights and searchable activity views with a signed (+/-) allocation ledger.
- Self-contained publish package plus per-user install and uninstall scripts.

### Removed
- The earlier file-explorer alpha.
15 changes: 15 additions & 0 deletions Directory.Build.props
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<Project>
<PropertyGroup>
<TargetFramework>net10.0-windows</TargetFramework>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<EnableWindowsTargeting>true</EnableWindowsTargeting>
<Version>0.2.0</Version>
<Product>ZipXP</Product>
<Authors>kiran kumar</Authors>
<Copyright>Copyright (c) 2026 kiran kumar</Copyright>
<Description>ZipXP: a solution to shortage of disk space. It shrinks files in place with Windows NTFS compression.</Description>
<RepositoryUrl>https://github.com/kiranscript/zipxp</RepositoryUrl>
</PropertyGroup>
<ItemGroup><Using Include="System.IO" /></ItemGroup>
</Project>
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2026 kiran kumar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
Loading
Loading