From 003c4c4e2683b0e6c8ecb9ca0778a18ff311e08a Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Fri, 9 Mar 2018 08:47:21 +0000 Subject: [PATCH] Moved readme files to own folder --- CONTRIBUTING.md | 2 +- README_faq.md | 4 ---- Tools/build-website.js | 8 ++++---- docs/index.html | 10 +++++----- README_debugging.md => readme/debugging.md | 0 README_desktop.md => readme/desktop.md | 0 README_donate.md => readme/donate.md | 0 README_e2ee.md => readme/e2ee.md | 0 readme/faq.md | 11 +++++++++++ README_spec.md => readme/spec.md | 0 README_terminal.md => readme/terminal.md | 0 11 files changed, 21 insertions(+), 14 deletions(-) delete mode 100644 README_faq.md rename README_debugging.md => readme/debugging.md (100%) rename README_desktop.md => readme/desktop.md (100%) rename README_donate.md => readme/donate.md (100%) rename README_e2ee.md => readme/e2ee.md (100%) create mode 100644 readme/faq.md rename README_spec.md => readme/spec.md (100%) rename README_terminal.md => readme/terminal.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6bc9f976e..751078ab2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README_faq.md b/README_faq.md deleted file mode 100644 index a0bde9d52..000000000 --- a/README_faq.md +++ /dev/null @@ -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. - diff --git a/Tools/build-website.js b/Tools/build-website.js index 07c1381c9..094ea7a86 100644 --- a/Tools/build-website.js +++ b/Tools/build-website.js @@ -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', {}); } diff --git a/docs/index.html b/docs/index.html index deb249efb..09f559b03 100644 --- a/docs/index.html +++ b/docs/index.html @@ -406,14 +406,14 @@ $$ Croatian hr_HR -Hrvoje Mandić trbuhom@net.hr +Hrvoje Mandić trbuhom@net.hr 66% Deutsch de_DE -Tobias Strobel git@strobeltobias.de +Tobias Strobel git@strobeltobias.de 83% @@ -427,7 +427,7 @@ $$ Español es_ES -Fernando Martín f@mrtn.es +Fernando Martín f@mrtn.es 93% @@ -462,14 +462,14 @@ $$ Русский ru_RU -Artyom Karlov artyom.karlov@gmail.com +Artyom Karlov artyom.karlov@gmail.com 85% 中文 (简体) zh_CN -RCJacH RCJacH@outlook.com +RCJacH RCJacH@outlook.com 68% diff --git a/README_debugging.md b/readme/debugging.md similarity index 100% rename from README_debugging.md rename to readme/debugging.md diff --git a/README_desktop.md b/readme/desktop.md similarity index 100% rename from README_desktop.md rename to readme/desktop.md diff --git a/README_donate.md b/readme/donate.md similarity index 100% rename from README_donate.md rename to readme/donate.md diff --git a/README_e2ee.md b/readme/e2ee.md similarity index 100% rename from README_e2ee.md rename to readme/e2ee.md diff --git a/readme/faq.md b/readme/faq.md new file mode 100644 index 000000000..93b54d7ca --- /dev/null +++ b/readme/faq.md @@ -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". \ No newline at end of file diff --git a/README_spec.md b/readme/spec.md similarity index 100% rename from README_spec.md rename to readme/spec.md diff --git a/README_terminal.md b/readme/terminal.md similarity index 100% rename from README_terminal.md rename to readme/terminal.md