-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'release' of https://github.com/HoaX7/noteapp into dev
- Loading branch information
Showing
7 changed files
with
18 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <h1 class="mt-8">Installation Guide</h1><p>The latest official installers for macOs and Windows can be found at <a target="_blank" rel="noopener noreferrer nofollow" class="underline text-blue-600" href="https://github.com/HoaX7/noteapp/releases">Github Releases</a> page. Read on for details regarding specific Oses.</p><h2 class="mt-8">MacOs</h2><p>Download the <code class="px-1 bg-gray-200 rounded">DMG</code> file from the <a target="_blank" rel="noopener noreferrer nofollow" class="underline text-blue-600" href="https://github.com/HoaX7/noteapp/releases/tag/app-v0.4.1">Latest Release</a>.</p><p></p><p><strong>Application Signing</strong></p><p><em>Scribe</em> is not signed (due to its cost) so you will need to use a workaround for the first run. Follow these steps to run the app.</p><ul class="px-2 mx-2 my-2"><li class="my-1"><p>Intel Chips: <a target="_blank" rel="noopener noreferrer nofollow" class="underline text-blue-600" href="https://support.apple.com/en-gb/guide/mac-help/mh40616/mac">Open a Mac app from an unidentified developer</a></p></li><li class="my-1"><p>Apple Chips: Try the same steps as Intel and if it still doesn’t work open a terminal and run this command:</p><pre><code>sudo xattr -r -d com.apple.quarantine /Applications/scribe.app</code></pre><p>Not sure what chip your Mac has? <a target="_blank" rel="noopener noreferrer nofollow" class="underline text-blue-600" href="https://support.apple.com/en-us/116943">Here’s how to find out</a>.</p></li></ul><h2 class="mt-8">Windows</h2><p>Download the <code class="px-1 bg-gray-200 rounded">setup.exe</code> file from the <a target="_blank" rel="noopener noreferrer nofollow" class="underline text-blue-600" href="https://github.com/HoaX7/noteapp/releases/tag/app-v0.4.1">Latest Release</a>. Follow through the setup wizard to install the app.</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| <h1 class="mt-8">Scribe</h1><p>A Simple opensource note taking app perfect for quick notes or detailed plans, stay on top of your day and never lose track of your ideas again.</p><p>This markdown was created using scribe.</p><h2 class="mt-8">Quick notes</h2><p>Press <code class="px-1 bg-gray-200 rounded">Ctrl+Enter</code>, <code class="px-1 bg-gray-200 rounded">Cmd+Enter</code> on Macos from anywhere to jot down notes without having to worry about where to save them. The app will automatically save the contents in a <code class="px-1 bg-gray-200 rounded">quicknotes.md</code> in the selected directory.</p><p>The Quick Note window will not open if the foreground window is on full screen mode on windows.</p><h1 class="mt-8">Settings</h1><p><strong>Note: You must move the files manually to the new save directory.</strong></p><p>All your settings are saved in a<strong> </strong><code class="px-1 bg-gray-200 rounded">settings.toml</code> file.</p><h2 class="mt-8">Windows</h2><p>All notes by default are saved in the installation path under a <code class="px-1 bg-gray-200 rounded">docs</code> folder.</p><p>You can modify the save path by clicking on <code class="px-1 bg-gray-200 rounded">File > Settings</code>.</p><h2 class="mt-8">Macos</h2><p>All notes by default are saved under <code class="px-1 bg-gray-200 rounded">$HOME_DIR/scribe/docs</code>. To modify the save path click on the icon in the menu bar > <code class="px-1 bg-gray-200 rounded">Settings</code>.</p><h1 class="mt-8">Key features</h1><ul class="px-2 mx-2 my-2"><li class="my-1"><p>Built for speed with rust.</p></li><li class="my-1"><p>Close the app and take notes from anywhere.</p></li><li class="my-1"><p>Markdown shortcuts make it easy to format the text while typing.</p><p>To test that, start a new line and type <code class="px-1 bg-gray-200 rounded">#</code> followed by a space to get a heading. Try <code class="px-1 bg-gray-200 rounded">#</code>, <code class="px-1 bg-gray-200 rounded">##</code>, <code class="px-1 bg-gray-200 rounded">###</code>, <code class="px-1 bg-gray-200 rounded">####</code>, <code class="px-1 bg-gray-200 rounded">#####</code>, <code class="px-1 bg-gray-200 rounded">######</code> for different levels.</p></li><li class="my-1"><p>You can also try <code class="px-1 bg-gray-200 rounded">></code> for blockquotes, <code class="px-1 bg-gray-200 rounded">*</code>, <code class="px-1 bg-gray-200 rounded">-</code> or <code class="px-1 bg-gray-200 rounded">+</code> for bullet lists, or <code class="px-1 bg-gray-200 rounded">`foobar`</code> to highlight code, <code class="px-1 bg-gray-200 rounded">~~tildes~~</code> to strike text, or <code class="px-1 bg-gray-200 rounded">==equal signs==</code> to highlight text, <code class="px-1 bg-gray-200 rounded">(c)</code> to see how it’s converted to a proper © character. You can also try <code class="px-1 bg-gray-200 rounded">-></code>, <code class="px-1 bg-gray-200 rounded">>></code>, <code class="px-1 bg-gray-200 rounded">1/2</code>, <code class="px-1 bg-gray-200 rounded">!=</code>, or <code class="px-1 bg-gray-200 rounded">--</code>, <code class="px-1 bg-gray-200 rounded">**</code> for bold and <code class="px-1 bg-gray-200 rounded">_Italic_</code> <em>for italic.</em></p></li><li class="my-1"><p>An inline toolbar is also available when you select text.</p></li><li class="my-1"><p>To refresh the app press <code class="px-1 bg-gray-200 rounded">F5</code>.</p></li></ul><h1 class="mt-8">Roadmap</h1><ul class="px-2 mx-2 my-2"><li class="my-1"><p>Integration with notion.</p></li></ul> | ||
| <h1 class="mt-8">Scribe</h1><p>A Simple opensource note taking app perfect for quick notes or detailed plans, stay on top of your day and never lose track of your ideas again.</p><p>This markdown was created using scribe.</p><h2 class="mt-8">Installation</h2><p>Read the installation <a target="_blank" rel="noopener noreferrer nofollow" class="underline text-blue-600" href="https://github.com/HoaX7/noteapp/tree/master/installation">notes</a> for each Oses.</p><h2 class="mt-8">Quick notes</h2><p>Press <code class="px-1 bg-gray-200 rounded">Ctrl+Enter</code>, <code class="px-1 bg-gray-200 rounded">Cmd+Enter</code> on Macos from anywhere to jot down notes without having to worry about where to save them. The app will automatically save the contents in a <code class="px-1 bg-gray-200 rounded">quicknotes.md</code> in the selected directory.</p><p>The Quick Note window will not open if the foreground window is on full screen mode on windows.</p><h1 class="mt-8">Settings</h1><p><strong>Note: You must move the files manually to the new save directory.</strong></p><p>All your settings are saved in a<strong> </strong><code class="px-1 bg-gray-200 rounded">settings.toml</code> file.</p><h2 class="mt-8">Windows</h2><p>All notes by default are saved in the installation path under a <code class="px-1 bg-gray-200 rounded">docs</code> folder.</p><p>You can modify the save path by clicking on <code class="px-1 bg-gray-200 rounded">File > Settings</code>.</p><h2 class="mt-8">Macos</h2><p>All notes by default are saved under <code class="px-1 bg-gray-200 rounded">$HOME_DIR/scribe/docs</code>. To modify the save path click on the icon in the menu bar > <code class="px-1 bg-gray-200 rounded">Settings</code>.</p><h1 class="mt-8">Key features</h1><ul class="px-2 mx-2 my-2"><li class="my-1"><p>Built for speed with rust.</p></li><li class="my-1"><p>Close the app and take notes from anywhere.</p></li><li class="my-1"><p>Markdown shortcuts make it easy to format the text while typing.</p><p>To test that, start a new line and type <code class="px-1 bg-gray-200 rounded">#</code> followed by a space to get a heading. Try <code class="px-1 bg-gray-200 rounded">#</code>, <code class="px-1 bg-gray-200 rounded">##</code>, <code class="px-1 bg-gray-200 rounded">###</code>, <code class="px-1 bg-gray-200 rounded">####</code>, <code class="px-1 bg-gray-200 rounded">#####</code>, <code class="px-1 bg-gray-200 rounded">######</code> for different levels.</p></li><li class="my-1"><p>You can also try <code class="px-1 bg-gray-200 rounded">></code> for blockquotes, <code class="px-1 bg-gray-200 rounded">*</code>, <code class="px-1 bg-gray-200 rounded">-</code> or <code class="px-1 bg-gray-200 rounded">+</code> for bullet lists, or <code class="px-1 bg-gray-200 rounded">`foobar`</code> to highlight code, <code class="px-1 bg-gray-200 rounded">~~tildes~~</code> to strike text, or <code class="px-1 bg-gray-200 rounded">==equal signs==</code> to highlight text, <code class="px-1 bg-gray-200 rounded">(c)</code> to see how it’s converted to a proper © character. You can also try <code class="px-1 bg-gray-200 rounded">-></code>, <code class="px-1 bg-gray-200 rounded">>></code>, <code class="px-1 bg-gray-200 rounded">1/2</code>, <code class="px-1 bg-gray-200 rounded">!=</code>, or <code class="px-1 bg-gray-200 rounded">--</code>, <code class="px-1 bg-gray-200 rounded">**</code> for bold and <code class="px-1 bg-gray-200 rounded">_Italic_</code> <em>for italic.</em></p></li><li class="my-1"><p>An inline toolbar is also available when you select text.</p></li><li class="my-1"><p>To refresh the app press <code class="px-1 bg-gray-200 rounded">F5</code>.</p></li></ul><h1 class="mt-8">Roadmap</h1><ul class="px-2 mx-2 my-2"><li class="my-1"><p>Integration with notion.</p></li></ul> |