README.md

PomodoroTimer

Pomodoro timer for Mac.

• 1. Install
• 2. Uninstall
• 3. Build
  • 3.1. Prerequisites
  • 3.2. Download the source code
  • 3.3. Project setup
  • 3.4. Compile app
    • 3.4.1. Compile app for x64
    • 3.4.2. Compile app for arm64
• 4. Other commands
  • 4.1. Execute test
  • 4.2. Compiles and start for development

1. Install

If you use intel mac, you can download PomodoroTimer.app from Release page.
Or you can also build PomodoroTimer.app for both intel mac and apple silicon mac from source code. (Recomended)

2. Uninstall

You can uninstall this app by the following steps.

1. Delete PomodoroTimer.app file.
2. Remove the following directory.

$ rm -r ~/.pomodoroTimer

3. Build

You can build PomodoroTimer.app from source code by the following steps.

3.1. Prerequisites

• git
• node
• npm

3.2. Download the source code

$ git clone https://github.com/um7a/pomodoro_timer.git
$ cd pomodoro_timer

3.3. Project setup

$ npm install

3.4. Compile app

3.4.1. Compile app for x64

$ npm run build:x64

Compiled app is in dist/mac/.

3.4.2. Compile app for arm64

$ npm run build:arm64

Compiled app is in dist/mac-arm64/.

4. Other commands

The following commands are useful when you edit the source code.

4.1. Execute test

$ npm run test

4.2. Compiles and start for development

$ npm run start