Updated Readme, mentioned Homebrew

CliClient/app/build-translation.js

@@ -68,8 +68,11 @@ function buildLocale(inputFile, outputFile) {
 }
 
 async function removePoHeaderDate(filePath) {
-	await execCommand('sed -i "" -e\'/POT-Creation-Date:/d\' "' + filePath + '"');
+	// Note: on macOS this will fail because it needs to be 'sed -i ""'
-	await execCommand('sed -i "" -e\'/PO-Revision-Date:/d\' "' + filePath + '"');
+	// Solution would be to install gsed, detect it here, and use it in place of sed in macOS
+	// https://stackoverflow.com/questions/30003570/how-to-use-gnu-sed-on-mac-os-x#34815955
+	await execCommand('sed -i -e\'/POT-Creation-Date:/d\' "' + filePath + '"');
+	await execCommand('sed -i -e\'/PO-Revision-Date:/d\' "' + filePath + '"');
 }
 
 async function createPotFile(potFilePath, sources) {

CliClient/locales/en_GB.po

@@ -562,7 +562,7 @@ msgstr ""
 msgid "Rename notebook:"
 msgstr ""
 
-msgid "Set or clear alarm:"
+msgid "Set alarm:"
 msgstr ""
 
 msgid "Layout"

CliClient/locales/es_CR.po

@@ -609,8 +609,8 @@ msgid "Rename notebook:"
 msgstr "Renombrar cuaderno:"
 
 #, fuzzy
-msgid "Set or clear alarm:"
+msgid "Set alarm:"
-msgstr "Establecer o eliminar alarma:"
+msgstr "Establecer alarma"
 
 #, fuzzy
 msgid "Layout"
@@ -996,3 +996,7 @@ msgstr "Actualmente no tiene cuadernos. Cree uno presionando el botón (+)."
 
 msgid "Welcome"
 msgstr "Bienvenido"
+
+#, fuzzy
+#~ msgid "Set or clear alarm:"
+#~ msgstr "Establecer o eliminar alarma:"

CliClient/locales/fr_FR.po

@@ -614,8 +614,9 @@ msgstr "Séparez chaque étiquette par une virgule."
 msgid "Rename notebook:"
 msgstr "Renommer le carnet :"
 
-msgid "Set or clear alarm:"
+#, fuzzy
-msgstr "Définir ou modifier alarme :"
+msgid "Set alarm:"
+msgstr "Définir ou modifier alarme"
 
 msgid "Layout"
 msgstr "Disposition"
@@ -1005,6 +1006,9 @@ msgstr ""
 msgid "Welcome"
 msgstr "Bienvenue"
 
+#~ msgid "Set or clear alarm:"
+#~ msgstr "Définir ou modifier alarme :"
+
 #~ msgid "Set or clear alarm"
 #~ msgstr "Définir ou modifier alarme"
 

CliClient/locales/joplin.pot

@@ -562,7 +562,7 @@ msgstr ""
 msgid "Rename notebook:"
 msgstr ""
 
-msgid "Set or clear alarm:"
+msgid "Set alarm:"
 msgstr ""
 
 msgid "Layout"

README.md

@@ -31,14 +31,18 @@ iOS              | <a href='https://itunes.apple.com/us/app/joplin/id1315599797'
 
 ## Terminal application
 
-On macOS, Linux or Windows (via [WSL](https://msdn.microsoft.com/en-us/commandline/wsl/faq?f=255&MSPPError=-2147217396)), type:
+**IMPORTANT: Node v8+ is required**
+
+On macOS:
+
+	brew install joplin
+
+On Linux or Windows (via [WSL](https://msdn.microsoft.com/en-us/commandline/wsl/faq?f=255&MSPPError=-2147217396)), type:
 
 	NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin
 	sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin
 
-**IMPORTANT: Node v8+ is required**
+By default, the application binary will be installed under `~/.joplin-bin`. You may change this directory if needed. Alternatively, if your npm permissions are setup as described [here](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-2-change-npms-default-directory-to-another-directory) (Option 2) then simply running `npm -g install joplin` would work.
-
-By default, the application binary will be installed under `~/.joplin-bin`. You may change this directory if needed.
 
 To start it, type `joplin`.
 

README_terminal.md

@@ -10,9 +10,18 @@ The notes can be [synchronised](#synchronisation) with various targets including
 
 # Installation
 
-On macOS, Linux or Windows (via [WSL](https://msdn.microsoft.com/en-us/commandline/wsl/faq?f=255&MSPPError=-2147217396)), type:
+**IMPORTANT: Node v8+ is required**
 
-    npm install -g joplin
+On macOS:
+
+	brew install joplin
+
+On Linux or Windows (via [WSL](https://msdn.microsoft.com/en-us/commandline/wsl/faq?f=255&MSPPError=-2147217396)), type:
+
+	NPM_CONFIG_PREFIX=~/.joplin-bin npm install -g joplin
+	sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin
+
+By default, the application binary will be installed under `~/.joplin-bin`. You may change this directory if needed. Alternatively, if your npm permissions are setup as described [here](https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-2-change-npms-default-directory-to-another-directory) (Option 2) then simply running `npm -g install joplin` would work.
 
 To start it, type `joplin`.
 
@@ -20,7 +29,7 @@ To start it, type `joplin`.
 
 The demo application shows various Wikipedia articles converted to Markdown and organised into notebooks, as well as an example to-do list, in order to test and demonstrate the application. The demo application and its settings will be installed in a separate directory so as not to interfere with any existing Joplin application.
 
-    npm install -g demo-joplin
+	npm install -g demo-joplin
 
 To start it, type `demo-joplin`.
 
@@ -54,27 +63,27 @@ Shortcut | Description
 
 Create a new note with title "Wednesday's meeting":
 
-    mknote "Wednesday's meeting"
+	mknote "Wednesday's meeting"
 
 Create a new to-do:
 
-    mktodo "Buy bread"
+	mktodo "Buy bread"
 
 Move the currently selected note ($n) to the notebook with title "Personal"
 
-    mv $n "Personal"
+	mv $n "Personal"
 
 Rename the currently selected notebook ($b) to "Something":
 
-    ren $b "Something"
+	ren $b "Something"
 
 Attach a local file to the currently selected note ($n):
 
-    ren $n /home/laurent/pictures/Vacation12.jpg
+	ren $n /home/laurent/pictures/Vacation12.jpg
 
 The configuration can also be changed from command-line mode. For example, to change the current editor to Sublime Text:
 
-    config editor "subl -w"
+	config editor "subl -w"
 
 ## Editing a note
 
@@ -108,7 +117,7 @@ Currently, synchronisation is possible with OneDrive (by default) or the local f
 
 To initiate the synchronisation process, type `:sync`. You will be asked to follow a link to authorise the application (simply input your Microsoft credentials - you do not need to register with OneDrive). After that, the application will synchronise in the background whenever it is running. It is possible to also synchronise outside of the user interface by typing `joplin sync` from the terminal. This can be used to setup a cron script to synchronise at regular interval. For example, this would do it every 30 minutes:
 
-    */30 * * * * /path/to/joplin sync
+	*/30 * * * * /path/to/joplin sync
 
 # URLs
 
@@ -132,189 +141,202 @@ In Markdown, links to resources are represented as a simple ID to the resource.
 
 There are two types of shortcuts: those that manipulate the user interface directly, such as `TAB` to move from one pane to another, and those that are simply shortcuts to actual commands. In a way similar to Vim, these shortcuts are generally a verb followed by an object. For example, typing `mn` ([m]ake [n]ote), is used to create a new note: it will switch the interface to command line mode and pre-fill it with `mknote ""` from where the title of the note can be entered. See below for the full list of shortcuts:
 
-    Tab       Give focus to next pane
+	Tab       Give focus to next pane
-    Shift+Tab Give focus to previous pane
+	Shift+Tab Give focus to previous pane
-    :         Enter command line mode
+	:         Enter command line mode
-    ESC       Exit command line mode
+	ESC       Exit command line mode
-    ENTER     Edit the selected note
+	ENTER     Edit the selected note
-    Ctrl+C    Cancel the current command.
+	Ctrl+C    Cancel the current command.
-    Ctrl+D    Exit the application.
+	Ctrl+D    Exit the application.
-    DELETE    Delete the currently selected note or notebook.
+	DELETE    Delete the currently selected note or notebook.
-    SPACE     Set a to-do as completed / not completed
+	SPACE     Set a to-do as completed / not completed
-    tc        [t]oggle [c]onsole between maximized/minimized/hidden/visible.
+	tc        [t]oggle [c]onsole between maximized/minimized/hidden/visible.
-    /         Search
+	/         Search
-    tm        [t]oggle note [m]etadata.
+	tm        [t]oggle note [m]etadata.
-    mn        [M]ake a new [n]ote
+	mn        [M]ake a new [n]ote
-    mt        [M]ake a new [t]odo
+	mt        [M]ake a new [t]odo
-    mb        [M]ake a new note[b]ook
+	mb        [M]ake a new note[b]ook
-    yn        Copy ([Y]ank) the [n]ote to a notebook.
+	yn        Copy ([Y]ank) the [n]ote to a notebook.
-    dn        Move the note to a notebook.
+	dn        Move the note to a notebook.
 
 # Available commands
 
 The following commands are available in [command-line mode](#command-line-mode):
 
-    attach <note> <file>
+	attach <note> <file>
 
-        Attaches the given file to the note.
+	    Attaches the given file to the note.
 
-    config [name] [value]
+	config [name] [value]
 
-        Gets or sets a config value. If [value] is not provided, it will show the 
+	    Gets or sets a config value. If [value] is not provided, it will show the 
-        value of [name]. If neither [name] nor [value] is provided, it will list 
+	    value of [name]. If neither [name] nor [value] is provided, it will list 
-        the current configuration.
+	    the current configuration.
 
-        -v, --verbose  Also displays unset and hidden config variables.
+	    -v, --verbose  Also displays unset and hidden config variables.
 
-    Possible keys/values:
+	Possible keys/values:
 
-        editor                 Text editor.
+	    sync.2.path            File system synchronisation target directory.
-                               The editor that will be used to open a note. If 
+	                           The path to synchronise with when file system 
-                               none is provided it will try to auto-detect the 
+	                           synchronisation is enabled. See `sync.target`.
-                               default editor.
+	                           Type: string.
-                               Type: string.
 	                           
-        locale                 Language.
+	    editor                 Text editor.
-                               Type: Enum.
+	                           The editor that will be used to open a note. If 
-                               Possible values: en_GB (English), fr_FR (Français).
+	                           none is provided it will try to auto-detect the 
-                               Default: "en_GB"
+	                           default editor.
+	                           Type: string.
 	                           
-        sync.2.path            File system synchronisation target directory.
+	    locale                 Language.
-                               The path to synchronise with when file system 
+	                           Type: Enum.
-                               synchronisation is enabled. See `sync.target`.
+	                           Possible values: en_GB (English), es_CR (Español), 
-                               Type: string.
+	                           fr_FR (Français).
+	                           Default: "en_GB"
 	                           
-        sync.interval          Synchronisation interval.
+	    dateFormat             Date format.
-                               Type: Enum.
+	                           Type: Enum.
-                               Possible values: 0 (Disabled), 300 (5 minutes), 600 
+	                           Possible values: DD/MM/YYYY (30/01/2017), DD/MM/YY 
-                               (10 minutes), 1800 (30 minutes), 3600 (1 hour), 
+	                           (30/01/17), MM/DD/YYYY (01/30/2017), MM/DD/YY 
-                               43200 (12 hours), 86400 (24 hours).
+	                           (01/30/17), YYYY-MM-DD (2017-01-30).
-                               Default: 300
+	                           Default: "DD/MM/YYYY"
 	                           
-        sync.target            Synchronisation target.
+	    timeFormat             Time format.
-                               The target to synchonise to. If synchronising with 
+	                           Type: Enum.
-                               the file system, set `sync.2.path` to specify the 
+	                           Possible values: HH:mm (20:30), h:mm A (8:30 PM).
-                               target directory.
+	                           Default: "HH:mm"
-                               Type: Enum.
-                               Possible values: 1 (Memory), 2 (File system), 3 
-                               (OneDrive).
-                               Default: 3
 	                           
-        trackLocation          Save geo-location with notes.
+	    uncompletedTodosOnTop  Show uncompleted todos on top of the lists.
-                               Type: bool.
+	                           Type: bool.
-                               Default: true
+	                           Default: true
 	                           
-        uncompletedTodosOnTop  Show uncompleted todos on top of the lists.
+	    trackLocation          Save geo-location with notes.
-                               Type: bool.
+	                           Type: bool.
-                               Default: true
+	                           Default: true
 	                           
-    cp <note> [notebook]
+	    sync.interval          Synchronisation interval.
+	                           Type: Enum.
+	                           Possible values: 0 (Disabled), 300 (5 minutes), 600 
+	                           (10 minutes), 1800 (30 minutes), 3600 (1 hour), 
+	                           43200 (12 hours), 86400 (24 hours).
+	                           Default: 300
 	                           
-        Duplicates the notes matching <note> to [notebook]. If no notebook is 
+	    sync.target            Synchronisation target.
-        specified the note is duplicated in the current notebook.
+	                           The target to synchonise to. If synchronising with 
+	                           the file system, set `sync.2.path` to specify the 
+	                           target directory.
+	                           Type: Enum.
+	                           Possible values: 2 (File system), 3 (OneDrive), 4 
+	                           (OneDrive Dev (For testing only)).
+	                           Default: 3
 
-    done <note>
+	cp <note> [notebook]
 
-        Marks a to-do as done.
+	    Duplicates the notes matching <note> to [notebook]. If no notebook is 
+	    specified the note is duplicated in the current notebook.
 
-    edit <note>
+	done <note>
 
-        Edit note.
+	    Marks a to-do as done.
 
-    exit
+	edit <note>
 
-        Exits the application.
+	    Edit note.
 
-    export <directory>
+	exit
 
-        Exports Joplin data to the given directory. By default, it will export the 
+	    Exits the application.
-        complete database including notebooks, notes, tags and resources.
 
-        --note <note>          Exports only the given note.
+	export <directory>
-        --notebook <notebook>  Exports only the given notebook.
 
-    geoloc <note>
+	    Exports Joplin data to the given directory. By default, it will export the 
+	    complete database including notebooks, notes, tags and resources.
 
-        Displays a geolocation URL for the note.
+	    --note <note>          Exports only the given note.
+	    --notebook <notebook>  Exports only the given notebook.
 
-    help [command]
+	geoloc <note>
 
-        Displays usage information.
+	    Displays a geolocation URL for the note.
 
-    import-enex <file> [notebook]
+	help [command]
 
-        Imports an Evernote notebook file (.enex file).
+	    Displays usage information.
 
-        -f, --force  Do not ask for confirmation.
+	import-enex <file> [notebook]
 
-    mkbook <new-notebook>
+	    Imports an Evernote notebook file (.enex file).
 
-        Creates a new notebook.
+	    -f, --force  Do not ask for confirmation.
 
-    mknote <new-note>
+	mkbook <new-notebook>
 
-        Creates a new note.
+	    Creates a new notebook.
 
-    mktodo <new-todo>
+	mknote <new-note>
 
-        Creates a new to-do.
+	    Creates a new note.
 
-    mv <note> [notebook]
+	mktodo <new-todo>
 
-        Moves the notes matching <note> to [notebook].
+	    Creates a new to-do.
 
-    ren <item> <name>
+	mv <note> [notebook]
 
-        Renames the given <item> (note or notebook) to <name>.
+	    Moves the notes matching <note> to [notebook].
 
-    rmbook <notebook>
+	ren <item> <name>
 
-        Deletes the given notebook.
+	    Renames the given <item> (note or notebook) to <name>.
 
-        -f, --force  Deletes the notebook without asking for confirmation.
+	rmbook <notebook>
 
-    rmnote <note-pattern>
+	    Deletes the given notebook.
 
-        Deletes the notes matching <note-pattern>.
+	    -f, --force  Deletes the notebook without asking for confirmation.
 
-        -f, --force  Deletes the notes without asking for confirmation.
+	rmnote <note-pattern>
 
-    search <pattern> [notebook]
+	    Deletes the notes matching <note-pattern>.
 
-        Searches for the given <pattern> in all the notes.
+	    -f, --force  Deletes the notes without asking for confirmation.
 
-    status
+	search <pattern> [notebook]
 
-        Displays summary about the notes and notebooks.
+	    Searches for the given <pattern> in all the notes.
 
-    sync
+	status
 
-        Synchronises with remote storage.
+	    Displays summary about the notes and notebooks.
 
-        --target <target>  Sync to provided target (defaults to sync.target config 
+	sync
-                           value)
-        --random-failures  For debugging purposes. Do not use.
 
-    tag <tag-command> [tag] [note]
+	    Synchronises with remote storage.
 
-        <tag-command> can be "add", "remove" or "list" to assign or remove [tag] 
+	    --target <target>  Sync to provided target (defaults to sync.target config 
-        from [note], or to list the notes associated with [tag]. The command `tag 
+	                       value)
-        list` can be used to list all the tags.
+	    --random-failures  For debugging purposes. Do not use.
 
-    todo <todo-command> <note-pattern>
+	tag <tag-command> [tag] [note]
 
-        <todo-command> can either be "toggle" or "clear". Use "toggle" to toggle 
+	    <tag-command> can be "add", "remove" or "list" to assign or remove [tag] 
-        the given to-do between completed and uncompleted state (If the target is 
+	    from [note], or to list the notes associated with [tag]. The command `tag 
-        a regular note it will be converted to a to-do). Use "clear" to convert 
+	    list` can be used to list all the tags.
-        the to-do back to a regular note.
 
-    undone <note>
+	todo <todo-command> <note-pattern>
 
-        Marks a to-do as non-completed.
+	    <todo-command> can either be "toggle" or "clear". Use "toggle" to toggle 
+	    the given to-do between completed and uncompleted state (If the target is 
+	    a regular note it will be converted to a to-do). Use "clear" to convert 
+	    the to-do back to a regular note.
 
-    version
+	undone <note>
 
-        Displays version information
+	    Marks a to-do as non-completed.
+
+	version
+
+	    Displays version information
 
 # License