1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-24 10:27:10 +02:00

Moved readme files to own folder

This commit is contained in:
Laurent Cozic 2018-03-09 08:47:21 +00:00
parent f08f89ebd4
commit 003c4c4e26
11 changed files with 21 additions and 14 deletions

View File

@ -1,6 +1,6 @@
# Reporting a bug
Please check first that it [has not already been reported](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Also consider [enabling debug mode](https://github.com/laurent22/joplin/blob/master/README_debugging.md) before reporting the issue so that you can provide as much details as possible to help fix it.
Please check first that it [has not already been reported](https://github.com/laurent22/joplin/issues?utf8=%E2%9C%93&q=is%3Aissue). Also consider [enabling debug mode](https://github.com/laurent22/joplin/blob/master/readme/debugging.md) before reporting the issue so that you can provide as much details as possible to help fix it.
If possible, **please provide a screenshot**. A screenshot showing the problem is often more useful than a paragraph describing it as it can make it immediately clear what the issue is.

View File

@ -1,4 +0,0 @@
# When I open a note in vim, the cursor is not visible
It seems to be due to the setting `set term=ansi` in .vimrc. Removing it should fix the issue. See https://github.com/laurent22/joplin/issues/147 for more information.

View File

@ -305,16 +305,16 @@ async function main() {
selectedHome: 'selected',
});
renderFileToHtml(rootDir + '/README_terminal.md', rootDir + '/docs/terminal/index.html', {
renderFileToHtml(rootDir + '/readme/terminal.md', rootDir + '/docs/terminal/index.html', {
selectedTerminal: 'selected',
});
renderFileToHtml(rootDir + '/README_desktop.md', rootDir + '/docs/desktop/index.html', {
renderFileToHtml(rootDir + '/readme/desktop.md', rootDir + '/docs/desktop/index.html', {
selectedDesktop: 'selected',
});
renderFileToHtml(rootDir + '/README_e2ee.md', rootDir + '/docs/help/e2ee.html', {});
renderFileToHtml(rootDir + '/README_spec.md', rootDir + '/docs/help/spec.html', {});
renderFileToHtml(rootDir + '/readme/e2ee.md', rootDir + '/docs/help/e2ee.html', {});
renderFileToHtml(rootDir + '/readme/spec.md', rootDir + '/docs/help/spec.html', {});
}

View File

@ -406,14 +406,14 @@ $$
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/hr.png" alt=""></td>
<td>Croatian</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/hr_HR.po">hr_HR</a></td>
<td>Hrvoje Mandić <a href="&#x6d;&#97;&#105;&#108;&#x74;&#111;&#58;&#116;&#x72;&#98;&#117;&#x68;&#111;&#x6d;&#64;&#110;&#x65;&#116;&#x2e;&#104;&#x72;">&#116;&#x72;&#98;&#117;&#x68;&#111;&#x6d;&#64;&#110;&#x65;&#116;&#x2e;&#104;&#x72;</a></td>
<td>Hrvoje Mandić <a href="&#x6d;&#97;&#x69;&#108;&#x74;&#111;&#x3a;&#116;&#x72;&#98;&#x75;&#x68;&#x6f;&#109;&#64;&#110;&#x65;&#116;&#46;&#x68;&#114;">&#116;&#x72;&#98;&#x75;&#x68;&#x6f;&#109;&#64;&#110;&#x65;&#116;&#46;&#x68;&#114;</a></td>
<td>66%</td>
</tr>
<tr>
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/de.png" alt=""></td>
<td>Deutsch</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/de_DE.po">de_DE</a></td>
<td>Tobias Strobel <a href="&#109;&#97;&#x69;&#x6c;&#x74;&#111;&#58;&#x67;&#x69;&#x74;&#x40;&#x73;&#116;&#114;&#111;&#x62;&#101;&#108;&#116;&#x6f;&#x62;&#105;&#97;&#x73;&#46;&#100;&#101;">&#x67;&#x69;&#x74;&#x40;&#x73;&#116;&#114;&#111;&#x62;&#101;&#108;&#116;&#x6f;&#x62;&#105;&#97;&#x73;&#46;&#100;&#101;</a></td>
<td>Tobias Strobel <a href="&#109;&#x61;&#105;&#108;&#116;&#x6f;&#58;&#x67;&#x69;&#116;&#x40;&#x73;&#x74;&#114;&#111;&#x62;&#x65;&#x6c;&#116;&#x6f;&#x62;&#105;&#x61;&#x73;&#x2e;&#x64;&#x65;">&#x67;&#x69;&#116;&#x40;&#x73;&#x74;&#114;&#111;&#x62;&#x65;&#x6c;&#116;&#x6f;&#x62;&#105;&#x61;&#x73;&#x2e;&#x64;&#x65;</a></td>
<td>83%</td>
</tr>
<tr>
@ -427,7 +427,7 @@ $$
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/es.png" alt=""></td>
<td>Español</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/es_ES.po">es_ES</a></td>
<td>Fernando Martín <a href="&#x6d;&#97;&#105;&#x6c;&#116;&#x6f;&#x3a;&#102;&#64;&#x6d;&#114;&#x74;&#110;&#46;&#101;&#115;">&#102;&#64;&#x6d;&#114;&#x74;&#110;&#46;&#101;&#115;</a></td>
<td>Fernando Martín <a href="&#x6d;&#97;&#x69;&#108;&#x74;&#x6f;&#58;&#102;&#64;&#109;&#114;&#x74;&#x6e;&#x2e;&#x65;&#115;">&#102;&#64;&#109;&#114;&#x74;&#x6e;&#x2e;&#x65;&#115;</a></td>
<td>93%</td>
</tr>
<tr>
@ -462,14 +462,14 @@ $$
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/ru.png" alt=""></td>
<td>Русский</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/ru_RU.po">ru_RU</a></td>
<td>Artyom Karlov <a href="&#109;&#97;&#x69;&#108;&#116;&#111;&#x3a;&#x61;&#114;&#116;&#x79;&#x6f;&#x6d;&#x2e;&#x6b;&#97;&#114;&#x6c;&#x6f;&#x76;&#x40;&#x67;&#109;&#x61;&#x69;&#x6c;&#x2e;&#x63;&#x6f;&#109;">&#x61;&#114;&#116;&#x79;&#x6f;&#x6d;&#x2e;&#x6b;&#97;&#114;&#x6c;&#x6f;&#x76;&#x40;&#x67;&#109;&#x61;&#x69;&#x6c;&#x2e;&#x63;&#x6f;&#109;</a></td>
<td>Artyom Karlov <a href="&#x6d;&#x61;&#x69;&#108;&#x74;&#111;&#x3a;&#97;&#114;&#x74;&#121;&#x6f;&#x6d;&#x2e;&#x6b;&#x61;&#114;&#108;&#111;&#x76;&#x40;&#103;&#109;&#97;&#105;&#x6c;&#46;&#x63;&#111;&#109;">&#97;&#114;&#x74;&#121;&#x6f;&#x6d;&#x2e;&#x6b;&#x61;&#114;&#108;&#111;&#x76;&#x40;&#103;&#109;&#97;&#105;&#x6c;&#46;&#x63;&#111;&#109;</a></td>
<td>85%</td>
</tr>
<tr>
<td><img src="https://raw.githubusercontent.com/stevenrskelton/flag-icon/master/png/16/country-4x3/cn.png" alt=""></td>
<td>中文 (简体)</td>
<td><a href="https://github.com/laurent22/joplin/blob/master/CliClient/locales/zh_CN.po">zh_CN</a></td>
<td>RCJacH <a href="&#x6d;&#97;&#x69;&#108;&#116;&#x6f;&#58;&#82;&#x43;&#x4a;&#97;&#99;&#x48;&#x40;&#111;&#x75;&#116;&#108;&#111;&#111;&#x6b;&#x2e;&#99;&#111;&#x6d;">&#82;&#x43;&#x4a;&#97;&#99;&#x48;&#x40;&#111;&#x75;&#116;&#108;&#111;&#111;&#x6b;&#x2e;&#99;&#111;&#x6d;</a></td>
<td>RCJacH <a href="&#109;&#x61;&#x69;&#108;&#x74;&#x6f;&#x3a;&#x52;&#67;&#74;&#x61;&#99;&#x48;&#x40;&#x6f;&#117;&#116;&#x6c;&#111;&#x6f;&#107;&#46;&#x63;&#111;&#x6d;">&#x52;&#67;&#74;&#x61;&#99;&#x48;&#x40;&#x6f;&#117;&#116;&#x6c;&#111;&#x6f;&#107;&#46;&#x63;&#111;&#x6d;</a></td>
<td>68%</td>
</tr>
<tr>

11
readme/faq.md Normal file
View File

@ -0,0 +1,11 @@
# When I open a note in vim, the cursor is not visible
It seems to be due to the setting `set term=ansi` in .vimrc. Removing it should fix the issue. See https://github.com/laurent22/joplin/issues/147 for more information.
# Is it possible to use real file and folder names in the sync target?
Unfortunately it is not possible. Joplin synchronises with file systems using an open format however it does not mean the sync files are meant to be user-editable. The format is designed to be performant and reliable, not user friendly (it cannot be both), and that cannot be changed. Joplin sync directory is basically just a database.
# Why is it named Joplin?
The name comes from the composer and pianist [Scott Joplin](https://en.wikipedia.org/wiki/Scott_Joplin), which I often listen to. His name is also easy to remember and type so it fell like a good choice. And, to quote a user on Hacker News, "though Scott Joplin's ragtime musical style has a lot in common with some very informal music, his own approach was more educated, sophisticated, and precise. Every note was in its place for a reason, and he was known to prefer his pieces to be performed exactly as written. So you could say that compared to the people who came before him, his notes were more organized".