Skip to content

Commit 87a9fe5

Browse files
committed
README: Add an Installation section and reorder a bit
1 parent 9230983 commit 87a9fe5

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,16 @@ Compactor is here to plug that gap, with a simple GUI utility anyone can use.
1010

1111
![](https://i.imgur.com/A9si8Zh.png)
1212

13-
The results are quite nice:
13+
## Installation [![v0.7.1](https://img.shields.io/github/release-pre/Freaky/Compactor.svg)](https://github.com/Freaky/Compactor/releases/tag/v0.7.1) [![Downloads](https://img.shields.io/github/downloads/Freaky/Compactor/total.svg)](https://github.com/Freaky/Compactor/releases)
1414

15-
| Program | Size | Compacted | Ratio |
16-
|-|-:|-:|-|
17-
| AI War 2 | 2.43 GiB | 1.42 GiB | 0.59x |
18-
| Big Pharma | 1.1 GiB | 711 MiB | 0.37x |
19-
| Crusader Kings 2 | 2.19 GiB | 1.29 GiB | 0.59x |
20-
| Deus Ex MD | 41.31 GiB | 28.06 GiB | 0.68x |
21-
| Infinifactory | 1.71 GiB | 742 MiB | 0.58x |
22-
| Satisfactory | 15.82 GiB | 10.45 GiB | 0.66x |
23-
| Space Engineers | 16.28 GiB | 9.4 GiB | 0.58x |
24-
| Stellaris | 7.76 GiB | 5.21 GiB | 0.67x |
25-
| Subnautica BZ | 10.62 GiB | 6.40 GiB | 0.60x |
26-
| The Long Dark | 7.42 GiB | 5.64 GiB | 0.76x |
27-
| Microsoft SDKs | 5.91 GiB | 2.45 GiB | 0.41x |
28-
| Visual Studio 2017 | 9.63 GiB | 4.77 GiB | 0.50x |
29-
| Windows Kits | 5.38 GiB | 2.03 GiB | 0.38x |
15+
Downloads are available from the [Github Releases](https://github.com/Freaky/Compactor/releases) page under *Assets*, or you can use these direct links:
16+
17+
* [v0.7.1 32-bit](https://github.com/Freaky/Compactor/releases/download/v0.7.1/Compactor-0.7.1-i686.zip)
18+
* [v0.7.1 64-bit](https://github.com/Freaky/Compactor/releases/download/v0.7.1/Compactor-0.7.1.zip)
19+
20+
If you get "*Windows protected your PC*" trying to run it, it's just [SmartScreen](https://www.pcworld.com/article/3197443/how-to-get-past-windows-defender-smartscreen-in-windows-10.html) upset the binaries aren't (yet) signed. Click "*More info*" and "*Run anyway*" if you judge things to be above-board.
21+
22+
Note this is beta software and comes with no warranty.
3023

3124
## Features
3225

@@ -86,6 +79,28 @@ This generally doesn't matter much for application folders, but it's not great f
8679

8780
If a game uses large files and in-place binary patching for updates, it might be worth adding to the exclusions list.
8881

82+
## Compression Results
83+
84+
A totally-not-cherry-picked sample of compression results with the default settings:
85+
86+
| Program | Size | Compacted | Ratio |
87+
|-|-:|-:|-|
88+
| AI War 2 | 2.43 GiB | 1.42 GiB | 0.59x |
89+
| Big Pharma | 1.1 GiB | 711 MiB | 0.37x |
90+
| Crusader Kings 2 | 2.19 GiB | 1.29 GiB | 0.59x |
91+
| Deus Ex MD | 41.31 GiB | 28.06 GiB | 0.68x |
92+
| Infinifactory | 1.71 GiB | 742 MiB | 0.58x |
93+
| Satisfactory | 15.82 GiB | 10.45 GiB | 0.66x |
94+
| Space Engineers | 16.28 GiB | 9.4 GiB | 0.58x |
95+
| Stellaris | 7.76 GiB | 5.21 GiB | 0.67x |
96+
| Subnautica BZ | 10.62 GiB | 6.40 GiB | 0.60x |
97+
| The Long Dark | 7.42 GiB | 5.64 GiB | 0.76x |
98+
| Microsoft SDKs | 5.91 GiB | 2.45 GiB | 0.41x |
99+
| Visual Studio 2017 | 9.63 GiB | 4.77 GiB | 0.50x |
100+
| Windows Kits | 5.38 GiB | 2.03 GiB | 0.38x |
101+
102+
A more comprehensive database of results is [maintained by the CompactGUI project](https://docs.google.com/spreadsheets/d/14CVXd6PTIYE9XlNpRsxJUGaoUzhC5titIC1rzQHI4yI/edit#gid=0).
103+
89104

90105
## Future
91106

@@ -111,7 +126,6 @@ More tentative:
111126

112127
Are you aware of any others? Do let me know.
113128

114-
115129
## Nerdy Technical Stuff
116130

117131
Compactor is primarily written in [Rust]. The front-end is basically an embedded website driven by the [web-view] crate and my own fork of the underlying [webview] library. It does *not* depend on any remote resources or open any ports.
@@ -122,7 +136,6 @@ Compresstimation uses a simple linear sampling algorithm, passing blocks through
122136

123137
The incompressible-files database is simply an append-only list of SipHash128 path hashes. It should be safe to share between multiple instances if you want to compress different drives at the same time. It lives in `%APPDATA%\Local\Freaky\Compactor`.
124138

125-
126139
## Author
127140

128141
Compactor is written by [Thomas Hurst], a nerdy, aloof weirdo from the north-east of England, and a programmer for about 25 years.
@@ -131,7 +144,6 @@ He mostly works with FreeBSD and focuses on Unix platforms, but uses Windows bec
131144

132145
You can find him on Twitter at [@blaagh], or bug him on IRC as `Freaky` on FreeNode.
133146

134-
135147
[`compact.exe`]: https://docs.microsoft.com/en-us/windows-server/administration/windows-commands/compact
136148
[Rust]: https://www.rust-lang.org/
137149
[CompactGUI]: https://github.com/ImminentFate/CompactGUI

0 commit comments

Comments
 (0)