Skip to content

Commit

Permalink
README.md lint
Browse files Browse the repository at this point in the history
  • Loading branch information
@szTheory
szTheory committed Apr 28, 2020
1 parent 9a43859 commit e0005ea
Showing 1 changed file with 73 additions and 72 deletions.
145 changes: 73 additions & 72 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# <img src="static/icon.png" height=27 alt="ExifCleaner Logo"> ExifCleaner

![Version](https://img.shields.io/github/v/release/szTheory/exifcleaner) ![Total Downloads](https://img.shields.io/github/downloads/szTheory/exifcleaner/total)

> Desktop app to clean metadata from images, videos, PDFs, and other files.
Expand Down Expand Up @@ -28,9 +29,9 @@

Linux, macOS 10.10+, and Windows 7+ are supported (64-bit only).

* **Linux**: [Download the .AppImage or .deb file](https://github.com/szTheory/exifcleaner/releases/latest)
* **macOS**: [Download the .dmg file](https://github.com/szTheory/exifcleaner/releases/latest)
* **Windows**: [Download the .exe file](https://github.com/szTheory/exifcleaner/releases/latest)
- **Linux**: [Download the .AppImage or .deb file](https://github.com/szTheory/exifcleaner/releases/latest)
- **macOS**: [Download the .dmg file](https://github.com/szTheory/exifcleaner/releases/latest)
- **Windows**: [Download the .exe file](https://github.com/szTheory/exifcleaner/releases/latest)

For Linux, The AppImage needs to be [made executable](http://discourse.appimage.org/t/how-to-make-an-appimage-executable/80) after download.

Expand All @@ -44,68 +45,68 @@ For Linux, The AppImage needs to be [made executable](http://discourse.appimage.

Below is a full list of supported file types that ExifCleaner will remove metadata for. It's based on which file types [ExifTool](https://exiftool.org/) supports write operations for.

* **3G2, 3GP2** – 3rd Gen. Partnership Project 2 a/v (QuickTime-based)
* **3GP, 3GPP** – 3rd Gen. Partnership Project a/v (QuickTime-based)
* **AAX** – Audible Enhanced Audiobook (QuickTime-based)
* **AI, AIT** – Adobe Illustrator [Template] (PS or PDF)
* **ARQ** – Sony Alpha Pixel-Shift RAW (TIFF-based)
* **ARW** – Sony Alpha RAW (TIFF-based)
* **AVIF** – AV1 Image File Format (QuickTime-based)
* **CR2** – Canon RAW 2 (TIFF-based) (CR2 spec)
* **CR3** – Canon RAW 3 (QuickTime-based) (CR3 spec)
* **CRM** – Canon RAW Movie (QuickTime-based)
* **CRW, CIFF** – Canon RAW Camera Image File Format (CRW spec)
* **CS1** – Sinar CaptureShop 1-shot RAW (PSD-based)
* **DCP DNG** – Camera Profile (DNG-like)
* **DNG** – Digital Negative (TIFF-based)
* **DR4** – Canon DPP version 4 Recipe
* **DVB** – Digital Video Broadcasting (QuickTime-based)
* **EPS, EPSF, PS** – [Encapsulated] PostScript Format
* **ERF** – Epson RAW Format (TIFF-based)
* **EXIF** – Exchangeable Image File Format metadata (TIFF-based)
* **EXV** – Exiv2 metadata file (JPEG-based)
* **F4A, F4B, F4P, F4V** – Adobe Flash Player 9+ Audio/Video (QuickTime-based)
* **FFF** – Hasselblad Flexible File Format (TIFF-based)
* **FLIF** – Free Lossless Image Format
* **GIF** – Compuserve Graphics Interchange Format
* **GPR** – GoPro RAW (DNG-based)
* **HDP, WDP, JXR** – Windows HD Photo / Media Photo / JPEG XR (TIFF-based)
* **HEIC, HEIF** – High Efficiency Image Format (QuickTime-based)
* **ICC, ICM** – International Color Consortium color profile
* **IIQ** – Phase One Intelligent Image Quality RAW (TIFF-based)
* **IND, INDD, INDT** – Adobe InDesign Document/Template
* **INSP** – Insta360 Picture (JPEG-based)
* **JP2, JPF, JPM, JPX** – JPEG 2000 image [Compound/Extended]
* **JPEG, JPG, JPE** – Joint Photographic Experts Group image
* **LRV** – Low-Resolution Video (QuickTime-based)
* **M4A, M4B, M4P, M4V** – MPEG-4 Audio/Video (QuickTime-based)
* **MEF** – Mamiya (RAW) Electronic Format (TIFF-based)
* **MIE** – Meta Information Encapsulation (MIE specification)
* **MOS** – Creo Leaf Mosaic (TIFF-based)
* **MOV, QT** – Apple QuickTime Movie
* **MP4** – Motion Picture Experts Group version 4 (QuickTime-based)
* **MPO** – Extended Multi-Picture format (JPEG with MPF extensions)
* **MQV** – Sony Mobile QuickTime Video
* **NEF** – Nikon (RAW) Electronic Format (TIFF-based)
* **NRW** – Nikon RAW (2) (TIFF-based)
* **ORF** – Olympus RAW Format (TIFF-based)
* **PDF** – Adobe Portable Document Format
* **PEF** – Pentax (RAW) Electronic Format (TIFF-based)
* **PNG, JNG, MNG** – Portable/JPEG/Multiple-image Network Graphics
* **PPM, PBM, PGM** – Portable Pixel/Bit/Gray Map
* **PSD, PSB, PSDT** – PhotoShop Document / Large Document / Template
* **QTIF, QTI, QIF** – QuickTime Image File
* **RAF** – FujiFilm RAW Format
* **RAW** – Panasonic RAW (TIFF-based)
* **RW2** – Panasonic RAW 2 (TIFF-based)
* **RWL** – Leica RAW (TIFF-based)
* **SR2** – Sony RAW 2 (TIFF-based)
* **SRW** – Samsung RAW format (TIFF-based)
* **THM** – Thumbnail image (JPEG)
* **TIFF, TIF** – Tagged Image File Format
* **VRD** – Canon DPP Recipe Data
* **X3F** – Sigma/Foveon RAW
* **XMP** – Extensible Metadata Platform sidecar file
- **3G2, 3GP2** – 3rd Gen. Partnership Project 2 a/v (QuickTime-based)
- **3GP, 3GPP** – 3rd Gen. Partnership Project a/v (QuickTime-based)
- **AAX** – Audible Enhanced Audiobook (QuickTime-based)
- **AI, AIT** – Adobe Illustrator [Template] (PS or PDF)
- **ARQ** – Sony Alpha Pixel-Shift RAW (TIFF-based)
- **ARW** – Sony Alpha RAW (TIFF-based)
- **AVIF** – AV1 Image File Format (QuickTime-based)
- **CR2** – Canon RAW 2 (TIFF-based) (CR2 spec)
- **CR3** – Canon RAW 3 (QuickTime-based) (CR3 spec)
- **CRM** – Canon RAW Movie (QuickTime-based)
- **CRW, CIFF** – Canon RAW Camera Image File Format (CRW spec)
- **CS1** – Sinar CaptureShop 1-shot RAW (PSD-based)
- **DCP DNG** – Camera Profile (DNG-like)
- **DNG** – Digital Negative (TIFF-based)
- **DR4** – Canon DPP version 4 Recipe
- **DVB** – Digital Video Broadcasting (QuickTime-based)
- **EPS, EPSF, PS** – [Encapsulated] PostScript Format
- **ERF** – Epson RAW Format (TIFF-based)
- **EXIF** – Exchangeable Image File Format metadata (TIFF-based)
- **EXV** – Exiv2 metadata file (JPEG-based)
- **F4A, F4B, F4P, F4V** – Adobe Flash Player 9+ Audio/Video (QuickTime-based)
- **FFF** – Hasselblad Flexible File Format (TIFF-based)
- **FLIF** – Free Lossless Image Format
- **GIF** – Compuserve Graphics Interchange Format
- **GPR** – GoPro RAW (DNG-based)
- **HDP, WDP, JXR** – Windows HD Photo / Media Photo / JPEG XR (TIFF-based)
- **HEIC, HEIF** – High Efficiency Image Format (QuickTime-based)
- **ICC, ICM** – International Color Consortium color profile
- **IIQ** – Phase One Intelligent Image Quality RAW (TIFF-based)
- **IND, INDD, INDT** – Adobe InDesign Document/Template
- **INSP** – Insta360 Picture (JPEG-based)
- **JP2, JPF, JPM, JPX** – JPEG 2000 image [Compound/Extended]
- **JPEG, JPG, JPE** – Joint Photographic Experts Group image
- **LRV** – Low-Resolution Video (QuickTime-based)
- **M4A, M4B, M4P, M4V** – MPEG-4 Audio/Video (QuickTime-based)
- **MEF** – Mamiya (RAW) Electronic Format (TIFF-based)
- **MIE** – Meta Information Encapsulation (MIE specification)
- **MOS** – Creo Leaf Mosaic (TIFF-based)
- **MOV, QT** – Apple QuickTime Movie
- **MP4** – Motion Picture Experts Group version 4 (QuickTime-based)
- **MPO** – Extended Multi-Picture format (JPEG with MPF extensions)
- **MQV** – Sony Mobile QuickTime Video
- **NEF** – Nikon (RAW) Electronic Format (TIFF-based)
- **NRW** – Nikon RAW (2) (TIFF-based)
- **ORF** – Olympus RAW Format (TIFF-based)
- **PDF** – Adobe Portable Document Format
- **PEF** – Pentax (RAW) Electronic Format (TIFF-based)
- **PNG, JNG, MNG** – Portable/JPEG/Multiple-image Network Graphics
- **PPM, PBM, PGM** – Portable Pixel/Bit/Gray Map
- **PSD, PSB, PSDT** – PhotoShop Document / Large Document / Template
- **QTIF, QTI, QIF** – QuickTime Image File
- **RAF** – FujiFilm RAW Format
- **RAW** – Panasonic RAW (TIFF-based)
- **RW2** – Panasonic RAW 2 (TIFF-based)
- **RWL** – Leica RAW (TIFF-based)
- **SR2** – Sony RAW 2 (TIFF-based)
- **SRW** – Samsung RAW format (TIFF-based)
- **THM** – Thumbnail image (JPEG)
- **TIFF, TIF** – Tagged Image File Format
- **VRD** – Canon DPP Recipe Data
- **X3F** – Sigma/Foveon RAW
- **XMP** – Extensible Metadata Platform sidecar file

## Development

Expand All @@ -116,20 +117,20 @@ Built with [Electron](https://electronjs.org). Uses [node-exiftool](https://www.
Clone the repository and cd into the directory.

```bash
$ git clone https://github.com/szTheory/exifcleaner.git
$ cd exifcleaner
git clone https://github.com/szTheory/exifcleaner.git
cd exifcleaner
```

Next, install the NPM package dependencies.

```bash
$ yarn install
yarn install
```

Finally, launch the application. This supports Hot Module Reload (HMR) so you will automatically see your changes every time you save a file.

```bash
$ yarn run dev
yarn run dev
```

### Contributing
Expand All @@ -140,9 +141,9 @@ This app is mostly feature complete. I want to keep it simple and not add a bunc

This section is really for my own reference when publishing a new release.

```
$ yarn run release
$ yarn run dist
```bash
yarn run release
yarn run dist
```

Or instead of `yarn run dist`, after Travis finishes building your app, open the release draft it created and click "Publish".

0 comments on commit e0005ea

Please sign in to comment.