Skip to content

Commit

Permalink
README clean up Development section
Browse files Browse the repository at this point in the history
  • Loading branch information
szTheory committed Feb 21, 2020
1 parent e475f71 commit 62efdcd
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
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)
* **Windows**: [Download the .exe 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 Down Expand Up @@ -111,18 +111,32 @@ Below is a full list of supported file types that ExifCleaner will remove metada

Built with [Electron](https://electronjs.org). Uses [node-exiftool](https://www.npmjs.com/package/node-exiftool) as a wrapper for [Exiftool](https://exiftool.org/) binaries.

### Run
### Run in dev mode

Clone the repository and cd into the directory.

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

Next, install the NPM package dependencies.

```bash
$ npm install
$ npm run dev #this command is set up to give you HMR in dev
```

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

```bash
$ npm run dev
```

### Contributing

This app is mostly feature complete. I want to keep it simple and not add a bunch of bloat to it. And I want to avoid release churn. That said, there are a couple small features that might be worth adding. And there are a few minor bugs or points of cleanup that would be worth polishing. If you'd like to help check out the [Issue Tracker](https://github.com/szTheory/exifcleaner/issues) which contains an exhaustive list of known issues. Just pick one and submit a Pull Request or leave a comment and I can provide guidance or help if you need it. Make sure to test the app out to see if it still works though. There isn't much going on this app so it should be easy enough to do. I might add some automated tests later on to help with this. For now it's just been me working on the app so manual testing has worked out fine.

### Publish
### Publish a new release

```
$ npm run release
Expand Down

0 comments on commit 62efdcd

Please sign in to comment.