Skip to content

Commit

Permalink
added new screenshots, updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
antingle committed May 6, 2022
1 parent 2cf39cc commit 98ae70e
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,23 @@

A calculator that lives in your menu bar and keeps a history of your calculations

<p float="left">
<img src="media/screenshot.png" alt="Calculator in the menu bar!" style="width: 300px">
<img src="media/screenshot_window.png" alt="Calculator window" style="width: 300px">
</p>
<div align="left">
<img width="300" src="media/menubar_dark.png#gh-dark-mode-only" alt="Calculator in the menu bar">
<img width="300" src="media/window_dark.png#gh-dark-mode-only" alt="Calculator window">
<img width="300" src="media/menubar_light.png#gh-light-mode-only" alt="Calculator in the menu bar">
<img width="300" src="media/window_light.png#gh-light-mode-only" alt="Calculator window">
<br>
</div>

## Opening

- The app is currently not signed, so simply double clicking the app will not open it
- You must right click the app and choose 'Open'
- You will then receieve a warning popup that the app cannot be checked for malicious software
- You can then choose the button to 'Open' it

## Usage

- Calculator can be accessed by pressing the `f(x)` symbol in your menu bar
- The calculator can also be toggled with the global shortcut `option + command + c`
- Calculations can be typed and submitted to history by pressing `Enter`
Expand All @@ -25,6 +30,7 @@ A calculator that lives in your menu bar and keeps a history of your calculation
- A live preview of the calculation is shown while typing an expression

### Notes

- Non-valid calculations cannot be submitted to history
- Syntax must be valid (only numbers with supported operators, functions and constants)
- Closing parentheses are added upon submission of an expression if open pairs are missing their closed counterparts
Expand Down Expand Up @@ -82,6 +88,8 @@ min(x,y,[...])
```

### Credits

- The [Expression](https://github.com/nicklockwood/Expression#math-symbols) framework by Nick Lockwood
- The [HotKey](https://github.com/soffes/HotKey) package by soffes
- The [KeyboardShortcuts](https://github.com/sindresorhus/KeyboardShortcuts) package by sindresorhus
- The [LaunchAtLogin](https://github.com/sindresorhus/LaunchAtLogin) package by sindresorhus

Binary file added media/menubar_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/menubar_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed media/screenshot.png
Binary file not shown.
Binary file removed media/screenshot_window.png
Binary file not shown.
Binary file added media/window_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/window_light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 98ae70e

Please sign in to comment.