README.md 1.89 KB
Newer Older
Fabrice Romand's avatar
Fabrice Romand committed
1 2
# ClipboardMemo README

Fabrice Romand's avatar
Fabrice Romand committed
3
Copyright 2018,2019 - Fabrice Romand <fabrice.romand@gmail.com>  
Fabrice Romand's avatar
Fabrice Romand committed
4 5 6 7
ISC License (see LICENSE file)  
Icons credit :
- Sergey Ershov - https://www.iconfinder.com/iconsets/multimedia-75
- Bogdan Rosu - http://bogdanrosu.com/
Fabrice Romand's avatar
Fabrice Romand committed
8

9 10
App website : https://clipboardmemo.romand.ovh (temporarily out of service).  
Binary releases : https://gitlab.com/fabrom/clipboardmemo/-/releases
Fabrice Romand's avatar
Fabrice Romand committed
11

Fabrice Romand's avatar
Fabrice Romand committed
12
## Description
Fabrice Romand's avatar
Fabrice Romand committed
13

Fabrice Romand's avatar
Fabrice Romand committed
14
This application capture, store and help managing all clipboard new contents (raw/rtf/html texts and PNG/JPEG images).
Fabrice Romand's avatar
Fabrice Romand committed
15
It's a simple dock application for Linux, MacOS and Windows.
Fabrice Romand's avatar
Fabrice Romand committed
16

Fabrice Romand's avatar
Fabrice Romand committed
17 18
Each record can be
- replayed by a simple click on it
Fabrice Romand's avatar
Fabrice Romand committed
19 20
- moved to clipboard (Cmd+Alt+V). Extracted records are remove from history
- removed
Fabrice Romand's avatar
Fabrice Romand committed
21

Fabrice Romand's avatar
Fabrice Romand committed
22
Even more, the historic can be :
Fabrice Romand's avatar
Fabrice Romand committed
23
- totally cleaned
Fabrice Romand's avatar
Fabrice Romand committed
24
- packed into one single entry (text only)
Fabrice Romand's avatar
Fabrice Romand committed
25

Fabrice Romand's avatar
Fabrice Romand committed
26
Clipboard capture can be paused.
Fabrice Romand's avatar
Fabrice Romand committed
27

28 29 30 31 32
Currently, the following languages are supported :
- English
- French
- Spanish

33
## Keyboards shorcuts
34
- Alt+Cmd+0..9 (or Alt+Ctrl+0..9) to copy the nth last clip in the clipboard
35 36 37
- Alt+Cmd+H (or Alt+Ctrl+H) to display the DB details window
- Alt+Cmd+V (or Alt+Ctrl+V) to put the last entry of the stack in the clipboard. Then you can use Cmd+V (or Ctrl+V) to paste the content of the clipboard.

Fabrice Romand's avatar
Fabrice Romand committed
38 39
## Limits 
Currently limits applied :
Fabrice Romand's avatar
Fabrice Romand committed
40 41 42
- max. 80 records (rotating list)
- max. 16 last records are displayed

Fabrice Romand's avatar
Fabrice Romand committed
43
## Installing the dependencies
Fabrice Romand's avatar
Fabrice Romand committed
44 45 46

  \> yarn install

Fabrice Romand's avatar
Fabrice Romand committed
47
## Running application from the sources
Fabrice Romand's avatar
Fabrice Romand committed
48 49 50 51 52

  \> yarn run start

  or
  
Fabrice Romand's avatar
Fabrice Romand committed
53
   \> yarn run dev (for development mode)
Fabrice Romand's avatar
Fabrice Romand committed
54

Fabrice Romand's avatar
Fabrice Romand committed
55 56
## Building packages

Fabrice Romand's avatar
Fabrice Romand committed
57
Build for all platforms : Linux (.deb, .rpm), MacOS (.dmg),  Windows (.exe)
Fabrice Romand's avatar
Fabrice Romand committed
58 59 60

  \> yarn dist

Fabrice Romand's avatar
Fabrice Romand committed
61 62 63 64 65 66
Build only for one platform

  \> yarn dist:linux  
  \> yarn dist:darwin  
  \> yarn dist:win32

Fabrice Romand's avatar
Fabrice Romand committed
67
DMG packages will be in *./dist/* directory
Fabrice Romand's avatar
Fabrice Romand committed
68

Fabrice Romand's avatar
Fabrice Romand committed
69
## Issues reporting
Fabrice Romand's avatar
Fabrice Romand committed
70 71 72

https://gitlab.com/fabrom/clipboardmemo/issues

Fabrice Romand's avatar
Fabrice Romand committed
73
## Contributions
Fabrice Romand's avatar
Fabrice Romand committed
74 75

https://gitlab.com/fabrom/clipboardmemo/merge_requests