From 42e0e1e5a5a42d7723f46cffe7fe202fa50337f5 Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Tue, 6 Feb 2018 09:42:20 +0000 Subject: [PATCH] Updated build instructions --- BUILD.md | 9 +++++++ README.md | 64 ++++++++++++++++++++++++------------------------- docs/index.html | 54 ++++++++++++++++++++--------------------- 3 files changed, 68 insertions(+), 59 deletions(-) diff --git a/BUILD.md b/BUILD.md index 905512b488..2ded1155a8 100644 --- a/BUILD.md +++ b/BUILD.md @@ -17,6 +17,15 @@ If you get a node-gyp related error you might need to manually install it: `npm - Install node v8.x (check with `node --version`) - https://nodejs.org/en/ - If you get a node-gyp related error you might need to manually install it: `npm install -g node-gyp` +# Building the tools + +Before building any of the applications, you need to build the tools: + +``` +cd Tools +npm install +``` + # Building the Electron application ``` diff --git a/README.md b/README.md index 6a6a1da6c6..220ba4879a 100644 --- a/README.md +++ b/README.md @@ -144,38 +144,6 @@ On mobile, the alarms will be displayed using the built-in notification system. If for any reason the notifications do not work, please [open an issue](https://github.com/laurent22/joplin/issues). -# Localisation - -Joplin is currently available in the languages below. If you would like to contribute a **new translation**, it is quite straightforward, please follow these steps: - -- [Download Poedit](https://poedit.net/), the translation editor, and install it. -- [Download the file to be translated](https://raw.githubusercontent.com/laurent22/joplin/master/CliClient/locales/joplin.pot). -- In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change "Country" and "Language" to your own country and language. -- From then you can translate the file. Once it is done, please either [open a pull request](https://github.com/laurent22/joplin/pulls) or send the file to [this address](https://raw.githubusercontent.com/laurent22/joplin/master/Assets/Adresse.png). - -To **update a translation**, follow the same steps as above but instead of getting the .pot file, get the .po file for your language from there: https://github.com/laurent22/joplin/tree/master/CliClient/locales - -This translation will apply to the three applications - desktop, mobile and terminal. - -Current translations: - - -  | Language | Code | Last translator | Percent done ----|---|---|---|--- -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/hr.png) | Croatian | hr_HR | Hrvoje Mandić | 72% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/de.png) | Deutsch | de_DE | Tobias Strobel | 92% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/gb.png) | English | en_GB | | 100% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/es.png) | Español | es_ES | Lucas Vieites | 80% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/cr.png) | Español (Costa Rica) | es_CR | | 68% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/fr.png) | Français | fr_FR | Laurent Cozic | 100% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/it.png) | Italiano | it_IT | | 76% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/be.png) | Nederlands | nl_BE | | 90% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/br.png) | Português (Brasil) | pt_BR | | 74% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/ru.png) | Русский | ru_RU | Artyom Karlov | 96% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/cn.png) | 中文 (简体) | zh_CN | RCJacH | 76% -![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/jp.png) | 日本語 | ja_JP | | 74% - - # Markdown Joplin uses and renders [Github-flavoured Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) with a few variations and additions. In particular: @@ -214,6 +182,38 @@ The checkboxes can then be ticked in the mobile and desktop applications. Please see the guide for information on how to contribute to the development of Joplin: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md +# Localisation + +Joplin is currently available in the languages below. If you would like to contribute a **new translation**, it is quite straightforward, please follow these steps: + +- [Download Poedit](https://poedit.net/), the translation editor, and install it. +- [Download the file to be translated](https://raw.githubusercontent.com/laurent22/joplin/master/CliClient/locales/joplin.pot). +- In Poedit, open this .pot file, go into the Catalog menu and click Configuration. Change "Country" and "Language" to your own country and language. +- From then you can translate the file. Once it is done, please either [open a pull request](https://github.com/laurent22/joplin/pulls) or send the file to [this address](https://raw.githubusercontent.com/laurent22/joplin/master/Assets/Adresse.png). + +To **update a translation**, follow the same steps as above but instead of getting the .pot file, get the .po file for your language from there: https://github.com/laurent22/joplin/tree/master/CliClient/locales + +This translation will apply to the three applications - desktop, mobile and terminal. + +Current translations: + + +  | Language | Code | Last translator | Percent done +---|---|---|---|--- +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/hr.png) | Croatian | hr_HR | Hrvoje Mandić | 72% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/de.png) | Deutsch | de_DE | Tobias Strobel | 92% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/gb.png) | English | en_GB | | 100% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/es.png) | Español | es_ES | Lucas Vieites | 80% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/cr.png) | Español (Costa Rica) | es_CR | | 68% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/fr.png) | Français | fr_FR | Laurent Cozic | 100% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/it.png) | Italiano | it_IT | | 76% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/be.png) | Nederlands | nl_BE | | 90% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/br.png) | Português (Brasil) | pt_BR | | 74% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/ru.png) | Русский | ru_RU | Artyom Karlov | 96% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/cn.png) | 中文 (简体) | zh_CN | RCJacH | 76% +![](https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/jp.png) | 日本語 | ja_JP | | 74% + + # Coming features - Mobile: manage tags diff --git a/docs/index.html b/docs/index.html index 15ff1ac570..bab8b88a97 100644 --- a/docs/index.html +++ b/docs/index.html @@ -328,6 +328,29 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin

See documentation and flow chart for reporter choice

On mobile, the alarms will be displayed using the built-in notification system.

If for any reason the notifications do not work, please open an issue.

+

Markdown

+

Joplin uses and renders Github-flavoured Markdown with a few variations and additions. In particular:

+

Math notation

+

Math expressions can be added using the Katex notation. To add an inline equation, wrap the expression in `{.katex}EXPRESSION` , eg. `{.katex}\sqrt{3x-1}+(1+x)^2` . To create an expression block, wrap it as follow:

+
```katex
+EXPRESSION
+```
+

For example:

+
```katex
+f(x) = \int_{-\infty}^\infty
+    \hat f(\xi)\,e^{2 \pi i \xi x}
+    \,d\xi
+```
+

Here is an example with the Markdown and rendered result side by side:

+

+

Checkboxes

+

Checkboxes can be added like so:

+
-[ ] Milk
+-[ ] Rice
+-[ ] Eggs
+

The checkboxes can then be ticked in the mobile and desktop applications.

+

Contributing

+

Please see the guide for information on how to contribute to the development of Joplin: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md

Localisation

Joplin is currently available in the languages below. If you would like to contribute a new translation, it is quite straightforward, please follow these steps:

    @@ -355,14 +378,14 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin Croatian hr_HR -Hrvoje Mandić trbuhom@net.hr +Hrvoje Mandić trbuhom@net.hr 72% Deutsch de_DE -Tobias Strobel git@strobeltobias.de +Tobias Strobel git@strobeltobias.de 92% @@ -418,14 +441,14 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin Русский ru_RU -Artyom Karlov artyom.karlov@gmail.com +Artyom Karlov artyom.karlov@gmail.com 96% 中文 (简体) zh_CN -RCJacH RCJacH@outlook.com +RCJacH RCJacH@outlook.com 76% @@ -438,29 +461,6 @@ sudo ln -s ~/.joplin-bin/bin/joplin /usr/bin/joplin -

    Markdown

    -

    Joplin uses and renders Github-flavoured Markdown with a few variations and additions. In particular:

    -

    Math notation

    -

    Math expressions can be added using the Katex notation. To add an inline equation, wrap the expression in `{.katex}EXPRESSION` , eg. `{.katex}\sqrt{3x-1}+(1+x)^2` . To create an expression block, wrap it as follow:

    -
    ```katex
-EXPRESSION
-```
-

    For example:

    -
    ```katex
-f(x) = \int_{-\infty}^\infty
-    \hat f(\xi)\,e^{2 \pi i \xi x}
-    \,d\xi
-```
-

    Here is an example with the Markdown and rendered result side by side:

    -

    -

    Checkboxes

    -

    Checkboxes can be added like so:

    -
    -[ ] Milk
--[ ] Rice
--[ ] Eggs
-

    The checkboxes can then be ticked in the mobile and desktop applications.

    -

    Contributing

    -

    Please see the guide for information on how to contribute to the development of Joplin: https://github.com/laurent22/joplin/blob/master/CONTRIBUTING.md

    Coming features

    • Mobile: manage tags