Skip to content

Commit 73245c8

Browse files
bengarrettbengarrett
committed
Fixed scoop instructions.
1 parent a93ebf7 commit 73245c8

File tree

1 file changed

+147
-147
lines changed

1 file changed

+147
-147
lines changed

‎docs/README.md

+147-147
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,147 @@
1-
# zipcmt
2-
3-
[![Go Reference](https://pkg.go.dev/badge/github.com/bengarrett/zipcmt.svg)](https://pkg.go.dev/github.com/bengarrett/zipcmt) [![GoReleaser](https://github.com/bengarrett/zipcmt/actions/workflows/release.yml/badge.svg)](https://github.com/bengarrett/zipcmt/actions/workflows/release.yml)
4-
5-
Zipcmt is the super-fast batch, zip file comment viewer, and extractor.
6-
7-
- Using a modern PC with the zip files stored on a solid-state drive, zipcmt handles many thousands of archives per second.
8-
- Comments convert to Unicode text for easy viewing, editing, or web hosting.<br>
9-
<small>* comments can also be left as-is in their original CP437 or ISO-8859 text encoding.</small>
10-
- Rarely see duplicate comments to avoid those annoying lists of identical site adverts.
11-
- Transfer the source zip file's last modification date over to any saved comments.
12-
- Tailored to both Windows and POSIX terminal platforms.
13-
14-
https://user-images.githubusercontent.com/513842/120908127-a7fc4580-c6aa-11eb-8a71-b3734fa53185.mp4
15-
16-
## Downloads
17-
18-
<small>zipcmt is a standalone (portable) terminal application and doesn't require installation.</small>
19-
20-
- [Windows](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_Windows_Intel.zip)
21-
- [macOS](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_macOS_Intel.tar.gz
22-
), [or for the Apple M chip](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_macOS_M-series.tar.gz
23-
)
24-
- [FreeBSD](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_FreeBSD_Intel.tar.gz
25-
)
26-
- [Linux](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_Linux_Intel.tar.gz
27-
)
28-
29-
### Packages
30-
31-
[APK (Alpine package)](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.apk)
32-
```sh
33-
wget https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.apk
34-
apk add zipcmt.apk
35-
```
36-
37-
[DEB (Debian package)](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.deb)
38-
```sh
39-
wget https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.deb
40-
dpkg -i zipcmt.deb
41-
```
42-
43-
[RPM (Red Hat package)](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.rpm)
44-
```sh
45-
wget https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.rpm
46-
rpm -i zipcmt.rpm
47-
```
48-
49-
Windows [Scoop](https://scoop.sh/)
50-
```sh
51-
scoop bucket add bengarrett https://github.com/bengarrett/zipcmt.git
52-
scoop install bengarrett/zipcmt
53-
```
54-
55-
## Windows Performance
56-
57-
It is highly encouraged that Windows users temporarily disable **Virus & threat protection, Real-time protection**, or [create **Windows Security Exclusion**s](https://support.microsoft.com/en-us/windows/add-an-exclusion-to-windows-security-811816c0-4dfd-af4a-47e4-c301afe13b26) for the folders to be scanned before running `zipcmt`. Otherwise, the hit to performance is amazingly stark!
58-
59-
```
60-
zipcmt -noprint 'C:\examples\'
61-
```
62-
63-
This is the time taken with the default Microsoft Defender settings.
64-
65-
> Scanned 11331 zip archives and found 412 unique comments, taking 1m38.9398945s
66-
67-
**1 minute and 38 seconds** to scan 11,000 zip archives.
68-
69-
---
70-
71-
This is the expected performance on an SSD with a Windows Security Exclusion in place.
72-
73-
> Scanned 11331 zip archives and found 412 unique comments, taking 1.593534s
74-
75-
**1.6 seconds** to scan the same 11,000 zip archives!
76-
77-
## Usage
78-
79-
![Usage screenshot on Windows](usage.png)
80-
81-
## Example usage
82-
#### Scan and print the comments
83-
```sh
84-
zipcmt test/
85-
86-
# ── test/test-with-comment.zip ───────────┐
87-
# This is an example test comment for zipcmt.
88-
#
89-
# Scanned 4 zip archives and found 1 unique comment
90-
```
91-
92-
#### Only print the comments
93-
```sh
94-
zipcmt --quiet test/
95-
96-
# This is an example test comment for zipcmt.
97-
```
98-
99-
#### Scan and save the comments
100-
101-
Linux, macOS, etc.
102-
103-
```sh
104-
zipcmt --noprint --save=~ test/
105-
106-
# Scanned 4 zip archives and found 1 unique comment
107-
108-
cat ~/test-with-comment-zipcomment.txt
109-
110-
# This is an example test comment for zipcmt.
111-
```
112-
113-
Windows PowerShell
114-
115-
```powershell
116-
zipcmt.exe --noprint --save='C:\Users\Ben\Documents' .\test\
117-
118-
# Scanned 4 zip archives and found 1 unique comment
119-
120-
cat 'C:\Users\Ben\Documents\test-with-comment-zipcomment.txt'
121-
122-
# This is an example test comment for zipcmt.
123-
```
124-
125-
## Build
126-
127-
[Go](https://golang.org/doc/install) supports dozens of architectures and operating systems letting zipcmt to [be built for most platforms](https://golang.org/doc/install/source#environment).
128-
129-
```sh
130-
# clone this repo
131-
git clone [email protected]:bengarrett/zipcmt.git
132-
133-
# access the repo
134-
cd zipcmt
135-
136-
# target and build the app for the host system
137-
go build
138-
139-
# target and build for Windows 7+ 32-bit
140-
env GOOS=windows GOARCH=386 go build
141-
142-
# target and build for OpenBSD
143-
env GOOS=openbsd GOARCH=amd64 go build
144-
145-
# target and build for Linux on MIPS CPUs
146-
env GOOS=linux GOARCH=mips64 go build
147-
```
1+
# zipcmt
2+
3+
[![Go Reference](https://pkg.go.dev/badge/github.com/bengarrett/zipcmt.svg)](https://pkg.go.dev/github.com/bengarrett/zipcmt) [![GoReleaser](https://github.com/bengarrett/zipcmt/actions/workflows/release.yml/badge.svg)](https://github.com/bengarrett/zipcmt/actions/workflows/release.yml)
4+
5+
Zipcmt is the super-fast batch, zip file comment viewer, and extractor.
6+
7+
- Using a modern PC with the zip files stored on a solid-state drive, zipcmt handles many thousands of archives per second.
8+
- Comments convert to Unicode text for easy viewing, editing, or web hosting.<br>
9+
<small>* comments can also be left as-is in their original CP437 or ISO-8859 text encoding.</small>
10+
- Rarely see duplicate comments to avoid those annoying lists of identical site adverts.
11+
- Transfer the source zip file's last modification date over to any saved comments.
12+
- Tailored to both Windows and POSIX terminal platforms.
13+
14+
https://user-images.githubusercontent.com/513842/120908127-a7fc4580-c6aa-11eb-8a71-b3734fa53185.mp4
15+
16+
## Downloads
17+
18+
<small>zipcmt is a standalone (portable) terminal application and doesn't require installation.</small>
19+
20+
- [Windows](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_Windows_Intel.zip)
21+
- [macOS](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_macOS_Intel.tar.gz
22+
), [or for the Apple M chip](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_macOS_M-series.tar.gz
23+
)
24+
- [FreeBSD](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_FreeBSD_Intel.tar.gz
25+
)
26+
- [Linux](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt_Linux_Intel.tar.gz
27+
)
28+
29+
### Packages
30+
31+
[APK (Alpine package)](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.apk)
32+
```sh
33+
wget https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.apk
34+
apk add zipcmt.apk
35+
```
36+
37+
[DEB (Debian package)](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.deb)
38+
```sh
39+
wget https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.deb
40+
dpkg -i zipcmt.deb
41+
```
42+
43+
[RPM (Red Hat package)](https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.rpm)
44+
```sh
45+
wget https://github.com/bengarrett/zipcmt/releases/latest/download/zipcmt.rpm
46+
rpm -i zipcmt.rpm
47+
```
48+
49+
Windows [Scoop](https://scoop.sh/)
50+
```sh
51+
scoop bucket add zipcmt https://github.com/bengarrett/zipcmt.git
52+
scoop install zipcmt
53+
```
54+
55+
## Windows Performance
56+
57+
It is highly encouraged that Windows users temporarily disable **Virus & threat protection, Real-time protection**, or [create **Windows Security Exclusion**s](https://support.microsoft.com/en-us/windows/add-an-exclusion-to-windows-security-811816c0-4dfd-af4a-47e4-c301afe13b26) for the folders to be scanned before running `zipcmt`. Otherwise, the hit to performance is amazingly stark!
58+
59+
```
60+
zipcmt -noprint 'C:\examples\'
61+
```
62+
63+
This is the time taken with the default Microsoft Defender settings.
64+
65+
> Scanned 11331 zip archives and found 412 unique comments, taking 1m38.9398945s
66+
67+
**1 minute and 38 seconds** to scan 11,000 zip archives.
68+
69+
---
70+
71+
This is the expected performance on an SSD with a Windows Security Exclusion in place.
72+
73+
> Scanned 11331 zip archives and found 412 unique comments, taking 1.593534s
74+
75+
**1.6 seconds** to scan the same 11,000 zip archives!
76+
77+
## Usage
78+
79+
![Usage screenshot on Windows](usage.png)
80+
81+
## Example usage
82+
#### Scan and print the comments
83+
```sh
84+
zipcmt test/
85+
86+
# ── test/test-with-comment.zip ───────────┐
87+
# This is an example test comment for zipcmt.
88+
#
89+
# Scanned 4 zip archives and found 1 unique comment
90+
```
91+
92+
#### Only print the comments
93+
```sh
94+
zipcmt --quiet test/
95+
96+
# This is an example test comment for zipcmt.
97+
```
98+
99+
#### Scan and save the comments
100+
101+
Linux, macOS, etc.
102+
103+
```sh
104+
zipcmt --noprint --save=~ test/
105+
106+
# Scanned 4 zip archives and found 1 unique comment
107+
108+
cat ~/test-with-comment-zipcomment.txt
109+
110+
# This is an example test comment for zipcmt.
111+
```
112+
113+
Windows PowerShell
114+
115+
```powershell
116+
zipcmt.exe --noprint --save='C:\Users\Ben\Documents' .\test\
117+
118+
# Scanned 4 zip archives and found 1 unique comment
119+
120+
cat 'C:\Users\Ben\Documents\test-with-comment-zipcomment.txt'
121+
122+
# This is an example test comment for zipcmt.
123+
```
124+
125+
## Build
126+
127+
[Go](https://golang.org/doc/install) supports dozens of architectures and operating systems letting zipcmt to [be built for most platforms](https://golang.org/doc/install/source#environment).
128+
129+
```sh
130+
# clone this repo
131+
git clone [email protected]:bengarrett/zipcmt.git
132+
133+
# access the repo
134+
cd zipcmt
135+
136+
# target and build the app for the host system
137+
go build
138+
139+
# target and build for Windows 7+ 32-bit
140+
env GOOS=windows GOARCH=386 go build
141+
142+
# target and build for OpenBSD
143+
env GOOS=openbsd GOARCH=amd64 go build
144+
145+
# target and build for Linux on MIPS CPUs
146+
env GOOS=linux GOARCH=mips64 go build
147+
```

0 commit comments

Comments
 (0)