From 6d3780c4ecd82023d31456d5049c36b8a9822a30 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 10:02:42 +1100 Subject: [PATCH 01/29] Update README.md --- docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7e7e098..fd5db81 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ # Welcome -This is the official documentation for massCode a free and open source code snippets manager for developers. +This is the official documentation for massCode, the free and open source snippet manager designed for developers. -[Get started](/essentials/layout.md) → +[Get Started →](/essentials/layout.md) From 81acc7869418bc2917d42c0eb88e55bb82234bc6 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 10:05:55 +1100 Subject: [PATCH 02/29] Update assistant.md --- docs/essentials/assistant.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/essentials/assistant.md b/docs/essentials/assistant.md index ea2fff2..c15476c 100644 --- a/docs/essentials/assistant.md +++ b/docs/essentials/assistant.md @@ -1,12 +1,12 @@ # Tray Assistant -> This feature available only on macOS. +> The tray assistant is only available on MacOS. -massCode assistant lives in the tray and gives you the ability to always have quick access to your snippets using the search. The snippet you selected will be copied to the clipboard. +The tray assistant lives in your tray (obviously) and gives you the ability to always have quick access to your snippets using the search function. The snippet you select will be copied to the clipboard. -## Show Assistant +## Using the Assistant -Follow one of the following steps: +To use the assistant, follow the steps below: - Click on the tray icon -- Press Option+S \ No newline at end of file +- Press Option+S From 3d88d9f3c547b49f33c9ae29cb4c9a0b47bac9d4 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 10:06:54 +1100 Subject: [PATCH 03/29] Update assistant.md --- docs/essentials/assistant.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/essentials/assistant.md b/docs/essentials/assistant.md index c15476c..aa1161b 100644 --- a/docs/essentials/assistant.md +++ b/docs/essentials/assistant.md @@ -2,7 +2,7 @@ > The tray assistant is only available on MacOS. -The tray assistant lives in your tray (obviously) and gives you the ability to always have quick access to your snippets using the search function. The snippet you select will be copied to the clipboard. +The tray assistant lives in your tray (obviously) and gives you the ability to access your snippets in a jiffy. The snippet you select will be copied to the clipboard. ## Using the Assistant From 74c5f7b8fa1c0af0d10901f8913bce118da1ab4d Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 10:54:56 +1100 Subject: [PATCH 04/29] Update folders.md --- docs/essentials/folders.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index 8f711be..1c0ee21 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -1,25 +1,25 @@ # Folders -massCode allows you to organize your snippets into multi-level folders. When you select a sidebar folder, all snippets in that folder, as well as in all subfolders, will be displayed in the second column. +massCode allows you to organize your snippets into multi-level folders. When you select a folder in the sidebar, all snippets in that folder, as well as in all subfolders, will be displayed in the second column. -## Adding a folder +## Adding a Folder -Follow one of the following steps: +To create a new folder, any of the following methods will work: -- Select **"File"** > **"New Folder"** from the menu bar. -- Click **"+"** button opposite **"FOLDERS"** in the library to add a new folder. +- Select **File** > **New Folder** from the menu bar. +- Click **+** button opposite **FOLDERS** in the library to add a new folder. - Press Shift+Cmd+N on macOS or Shift+Ctrl+N on Windows or Linux. -## Moving to folder +## Moving a Folder -Drag and drop the required folder to another folder. +Drag and drop a folder onto another folder to relocate it. -## Renaming and Deleting +## Renaming and Deleting Folders -Call the context menu by right-clicking on the folder and selecting **"Rename"** or **"Delete"**. +Bring up the context menu by right-clicking on the folder and selecting **Rename** or **Delete**. -> Deleting the folder will cause all snippets in it, as well as in all sub-folders, to move to **"InBox"**. +> Deleting the folder will cause all of its contents (snippets and subfolders) to move to **InBox**. -## Set the Default Folder Language +## Setting a Default Folder Language -Call the context menu by right-clicking on the folder and select **"Default Language"**. \ No newline at end of file +Bring up the context menu by right-clicking on the folder and then select **Default Language**. From eb1a981505d0f1efe614e83ed78c2db133dcbda9 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 10:55:27 +1100 Subject: [PATCH 05/29] Update assistant.md --- docs/essentials/assistant.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/essentials/assistant.md b/docs/essentials/assistant.md index aa1161b..6c4907c 100644 --- a/docs/essentials/assistant.md +++ b/docs/essentials/assistant.md @@ -8,5 +8,5 @@ The tray assistant lives in your tray (obviously) and gives you the ability to a To use the assistant, follow the steps below: -- Click on the tray icon -- Press Option+S +- Click on the tray icon. +- Press Option+S. From d2776fa2a284e5b5e89e5cfa66098d18fc8172f7 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:03:41 +1100 Subject: [PATCH 06/29] Update folders.md --- docs/essentials/folders.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index 1c0ee21..00be70a 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -4,7 +4,7 @@ massCode allows you to organize your snippets into multi-level folders. When you ## Adding a Folder -To create a new folder, any of the following methods will work: +To create a new folder, use one of the following methods: - Select **File** > **New Folder** from the menu bar. - Click **+** button opposite **FOLDERS** in the library to add a new folder. From 97478101b8973eea76fe939064dffe02639edb1d Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:04:40 +1100 Subject: [PATCH 07/29] Update fragments.md --- docs/essentials/fragments.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/essentials/fragments.md b/docs/essentials/fragments.md index bd73b77..64708c3 100644 --- a/docs/essentials/fragments.md +++ b/docs/essentials/fragments.md @@ -1,18 +1,18 @@ # Fragments -Fragments can also be attributed to the way snippets are organized. You can create tabs inside a snippet, for example, to create different versions of snippets or when a snippet consists of different languages. +Fragments are different versions of one snippet. They are stored as tabs within the snippet, and can be different langauges all together. For example. you can have two snippets in two different languages that perform similar functions, stored in one. -## Adding Fragment +## Creating a Fragment -Follow one of the following steps: +To create a fragment, use one of the following methods: -- Click **"+"** button on the top right corner of the editor. +- Click **+** button on the top right corner of the editor pane. - Press Cmd+T on macOS or Ctrl+F on Windows or Linux. -## Renaming and Deleting +## Renaming and Deleting Fragments -Call the context menu by right-clicking on the fragment and selecting **"Rename"** or **"Delete"**. +Bring up the context menu by right-clicking on the fragment and selecting **Rename** or **Delete**. -::: warning -The deleted fragment cannot be recovered. -::: \ No newline at end of file +::: WARNING +A deleted fragment cannot be recovered by any means. Proceed with caution! +::: From 54183fce490e716a787214d031617dc873b89ac1 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:04:49 +1100 Subject: [PATCH 08/29] Update fragments.md From 617f14ddcfd888e647e9769ec1cda43d3f2abdb7 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:07:34 +1100 Subject: [PATCH 09/29] Update layout.md --- docs/essentials/layout.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/essentials/layout.md b/docs/essentials/layout.md index 195a695..8b77fa2 100644 --- a/docs/essentials/layout.md +++ b/docs/essentials/layout.md @@ -1,5 +1,5 @@ # Layout -massCode has a three-column interface. The first column displays the application library where all snippets are stored. The second column displays all the snippets in the selected location. And the third column is the code editor, where you can edit the snippet code. +massCode has a three-column interface. The first column displays the application library where all of your snippets are stored. The second column displays all of the snippets in the selected location. And the third column is the editor pane, where you can edit snippets and fragments. - \ No newline at end of file + From cb1a73f959475734c28396010ef11ce21130f633 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:11:55 +1100 Subject: [PATCH 10/29] Update folders.md --- docs/essentials/folders.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index 00be70a..c48c992 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -18,7 +18,8 @@ Drag and drop a folder onto another folder to relocate it. Bring up the context menu by right-clicking on the folder and selecting **Rename** or **Delete**. -> Deleting the folder will cause all of its contents (snippets and subfolders) to move to **InBox**. +::: WARNING +Deleting a folder will cause all of its contents, including snippets, fragments and subfolders within it. Deleted snippets can be recovered through the **Trash**. ## Setting a Default Folder Language From d6d14f4317fa4f426818e987984fc4878e64e755 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:13:48 +1100 Subject: [PATCH 11/29] Update folders.md --- docs/essentials/folders.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index c48c992..c414d7a 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -7,7 +7,7 @@ massCode allows you to organize your snippets into multi-level folders. When you To create a new folder, use one of the following methods: - Select **File** > **New Folder** from the menu bar. -- Click **+** button opposite **FOLDERS** in the library to add a new folder. +- Click the **+** button opposite **FOLDERS** in the library to add a new folder. - Press Shift+Cmd+N on macOS or Shift+Ctrl+N on Windows or Linux. ## Moving a Folder From a67936c9dedcda2da4fa0d8bc93cf2354dcb79a9 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:14:17 +1100 Subject: [PATCH 12/29] Update fragments.md --- docs/essentials/fragments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/essentials/fragments.md b/docs/essentials/fragments.md index 64708c3..6f3718f 100644 --- a/docs/essentials/fragments.md +++ b/docs/essentials/fragments.md @@ -6,7 +6,7 @@ Fragments are different versions of one snippet. They are stored as tabs within To create a fragment, use one of the following methods: -- Click **+** button on the top right corner of the editor pane. +- Click the **+** button on the top right corner of the editor pane. - Press Cmd+T on macOS or Ctrl+F on Windows or Linux. ## Renaming and Deleting Fragments From 2422025541bfe45d827ff2767a273231091ad8c6 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:15:05 +1100 Subject: [PATCH 13/29] Update library.md --- docs/essentials/library.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/essentials/library.md b/docs/essentials/library.md index e620fb3..0bd2eff 100644 --- a/docs/essentials/library.md +++ b/docs/essentials/library.md @@ -1,6 +1,6 @@ # Library -The library located in the first column consists of system folders **"InBox"**, **"Favorites"**, **"All Snippets"**, **"Trash"**. +The library located in the first column consists of the main folders **InBox**, **Favorites**, **All Snippets**, **Trash**. ## Inbox @@ -12,12 +12,12 @@ You can add your favorite snippets to this folder for quick access. ## All Snippets -This folder contains all your snippets. +This folder contains all of your snippets. ## Trash -This is where the snippets you delete get in. You can completely delete snippets in this folder by calling the context menu on **"Trash"** and selecting **"Empty Trash"**. +This is where any snippets you delete will go. You can empty the contents of it by bringing up with context menu by right clicking **"Trash"** and selecting **"Empty Trash"**. ::: warning -Cleaning the trash will result in the complete removal of snippets. This action cannot be undone. -::: \ No newline at end of file +Emptying the trash cannot be undone. Proceed with caution! +::: From 1dd711f269943ea0f4470684ffbaadd0fb6a75c7 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 11:32:46 +1100 Subject: [PATCH 14/29] Update folders.md --- docs/essentials/folders.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index c414d7a..e541dab 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -1,26 +1,27 @@ # Folders -massCode allows you to organize your snippets into multi-level folders. When you select a folder in the sidebar, all snippets in that folder, as well as in all subfolders, will be displayed in the second column. +massCode allows you to organize your snippets into multi-level folders. When you select a folder in the sidebar, all of the snippets in that folder, as well as in its subfolders, will be displayed in the second column. -## Adding a Folder +## Creating a folder -To create a new folder, use one of the following methods: +Follow one of the options below in order to create a folder: - Select **File** > **New Folder** from the menu bar. -- Click the **+** button opposite **FOLDERS** in the library to add a new folder. +- Click **"+"** button opposite **FOLDERS** in the library to create a new folder. - Press Shift+Cmd+N on macOS or Shift+Ctrl+N on Windows or Linux. -## Moving a Folder +## Moving Folders -Drag and drop a folder onto another folder to relocate it. +Drag and drop the required folder onto another folder. -## Renaming and Deleting Folders +## Renaming and Deleting -Bring up the context menu by right-clicking on the folder and selecting **Rename** or **Delete**. +Call the context menu by right-clicking on the folder and selecting **"Rename** or **"Delete"**. -::: WARNING -Deleting a folder will cause all of its contents, including snippets, fragments and subfolders within it. Deleted snippets can be recovered through the **Trash**. +::: WARNING +Deleting the folder will cause all snippets in it, as well as in all sub-folders, to move to **Trash**. +::: -## Setting a Default Folder Language +## Set the Default Folder Language -Bring up the context menu by right-clicking on the folder and then select **Default Language**. +Call the context menu by right-clicking on the folder and select **"Default Language"**. From ef1a1388c6046a81147edaa52c4c6d5a6f2b28b6 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 16:57:15 +1100 Subject: [PATCH 15/29] Update README.md --- docs/markdown/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/markdown/README.md b/docs/markdown/README.md index 6808864..4e2851a 100644 --- a/docs/markdown/README.md +++ b/docs/markdown/README.md @@ -1,9 +1,7 @@ # Markdown -To use the Markdown you need to set the snippet language in **"Markdown"**. To do this, click on the language selector located at the bottom left of the editor panel, and choose **"Markdown"** from the drop-down list. +To utilise Markdown in massCode, you will need to first set the snippet language to **"Markdown"**. In order to do this, click on the language selector in the bottom left of the editor panel, and choose **"Markdown"** from the list. -## Preview Markdown +## Previewing Markdown -Follow one of the following steps: -- Select **"Editor"** > **"Preview Markdown"** from the menu bar. -- Click button on the top right corner of the editor \ No newline at end of file +To preview your Markdown snippets, either select **"Editor"** > **"Preview Markdown"** from the menu bar, or click the button, which is located in the top right corner of the editor. From 35cca57fe8cb9a93a38c90580888c273cbc0b1d1 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 16:58:41 +1100 Subject: [PATCH 16/29] Update assistant.md --- docs/essentials/assistant.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/essentials/assistant.md b/docs/essentials/assistant.md index 6c4907c..d1f81ce 100644 --- a/docs/essentials/assistant.md +++ b/docs/essentials/assistant.md @@ -1,12 +1,11 @@ # Tray Assistant -> The tray assistant is only available on MacOS. +::: NOTE +The tray assistant is only available on MacOS. +::: The tray assistant lives in your tray (obviously) and gives you the ability to access your snippets in a jiffy. The snippet you select will be copied to the clipboard. ## Using the Assistant -To use the assistant, follow the steps below: - -- Click on the tray icon. -- Press Option+S. +To use the assistant, click on the tray icon or press Option+S. From d8680f68bf25073e63c40210420d36f63206b976 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:00:33 +1100 Subject: [PATCH 17/29] Update folders.md --- docs/essentials/folders.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index e541dab..2694f55 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -4,10 +4,10 @@ massCode allows you to organize your snippets into multi-level folders. When you ## Creating a folder -Follow one of the options below in order to create a folder: +To create a folder, there are three methods, which are listed below: -- Select **File** > **New Folder** from the menu bar. -- Click **"+"** button opposite **FOLDERS** in the library to create a new folder. +- Select **"File"** > **"New Folder"** from the menu bar. +- Click **"+"** button opposite **"FOLDERS"** in the library to create a new folder. - Press Shift+Cmd+N on macOS or Shift+Ctrl+N on Windows or Linux. ## Moving Folders @@ -16,12 +16,12 @@ Drag and drop the required folder onto another folder. ## Renaming and Deleting -Call the context menu by right-clicking on the folder and selecting **"Rename** or **"Delete"**. +Bring up the context menu by right-clicking on the folder and selecting **"Rename"** or **"Delete"**. ::: WARNING -Deleting the folder will cause all snippets in it, as well as in all sub-folders, to move to **Trash**. +Deleting the folder will cause all snippets in it, as well as in all sub-folders, to move to **"Trash"**. ::: ## Set the Default Folder Language -Call the context menu by right-clicking on the folder and select **"Default Language"**. +Bring up the context menu by right-clicking on the folder and select **"Default Language"**. From 582a4967399191e00c981f21390837c885d6bcec Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:00:42 +1100 Subject: [PATCH 18/29] Update folders.md --- docs/essentials/folders.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index 2694f55..d363b4c 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -8,7 +8,7 @@ To create a folder, there are three methods, which are listed below: - Select **"File"** > **"New Folder"** from the menu bar. - Click **"+"** button opposite **"FOLDERS"** in the library to create a new folder. -- Press Shift+Cmd+N on macOS or Shift+Ctrl+N on Windows or Linux. +- Press Shift+Cmd+N on macOS or Shift+Ctrl+N on Windows and Linux. ## Moving Folders From 3eb1440f4642c61c523b6095363310df6ef9aa35 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:02:57 +1100 Subject: [PATCH 19/29] Update fragments.md --- docs/essentials/fragments.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/essentials/fragments.md b/docs/essentials/fragments.md index 6f3718f..014589c 100644 --- a/docs/essentials/fragments.md +++ b/docs/essentials/fragments.md @@ -1,13 +1,10 @@ # Fragments -Fragments are different versions of one snippet. They are stored as tabs within the snippet, and can be different langauges all together. For example. you can have two snippets in two different languages that perform similar functions, stored in one. +Fragments are just multiple snippets stored as one. They are stored as tabs within the snippet, and can be completely different langauges or perform completely different tasks. For example, you can have two snippets in two different languages that perform similar functions, stored in one (you can use it for anything else too). ## Creating a Fragment -To create a fragment, use one of the following methods: - -- Click the **+** button on the top right corner of the editor pane. -- Press Cmd+T on macOS or Ctrl+F on Windows or Linux. +To create a fragment, either click the **"+"** button in the top right corner of the editor pane, or press Cmd+T on macOS or Ctrl+F on Windows and Linux. ## Renaming and Deleting Fragments From c3d68ae9277e090d45410c58de6c2a59c77a0a60 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:09:01 +1100 Subject: [PATCH 20/29] Update layout.md --- docs/essentials/layout.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/essentials/layout.md b/docs/essentials/layout.md index 8b77fa2..3105a25 100644 --- a/docs/essentials/layout.md +++ b/docs/essentials/layout.md @@ -1,5 +1,17 @@ # Layout -massCode has a three-column interface. The first column displays the application library where all of your snippets are stored. The second column displays all of the snippets in the selected location. And the third column is the editor pane, where you can edit snippets and fragments. +massCode has an easy to use, three-column interface. This design maximises efficiency and the amount of relevant content you can view at once. + +## First Column + +The first column displays the application library. The application library houses all of the directories for your snippets and subfolders. + +## Second Column + +The second column displays all of the snippets in the selected location. + +## Third Column + +The last (but not least) column is the editor pane. This is most crucial part of the app and is where you will edit your snippets in, add tags and create fragments. From 16bd3f508ea83c831cfa1ec330c6b96e5f09abc1 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:16:44 +1100 Subject: [PATCH 21/29] Update library.md --- docs/essentials/library.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/essentials/library.md b/docs/essentials/library.md index 0bd2eff..086ee27 100644 --- a/docs/essentials/library.md +++ b/docs/essentials/library.md @@ -1,18 +1,18 @@ # Library -The library located in the first column consists of the main folders **InBox**, **Favorites**, **All Snippets**, **Trash**. +The library is located in the first column, and contains the **InBox**, **Favorites**, **All Snippets** and **Trash** folders. ## Inbox -This folder contains all unorganized snippets. +This folder contains all unorganized snippets (any snippets that have not been placed in a folder). ## Favorites -You can add your favorite snippets to this folder for quick access. +This folder contains all of the snippets that you have favourited, allowing for quick access. ## All Snippets -This folder contains all of your snippets. +This folder contains all of your snippets, regardless of location. ## Trash From 52875378f5ad9a6d06cb4eed072b0c4aa483b687 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:17:44 +1100 Subject: [PATCH 22/29] Update search.md --- docs/essentials/search.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/essentials/search.md b/docs/essentials/search.md index 5df160b..1c5a5b3 100644 --- a/docs/essentials/search.md +++ b/docs/essentials/search.md @@ -1,7 +1,7 @@ # Search -Follow one of the following steps: +To use the search feature in massCode, there are three methods which are listed below: - Select **"Edit"** > **"Find"** from the menu bar. - Click on the search entry field at the top of the second column. -- Press Cmd+F on macOS or Ctrl+F on Windows or Linux. \ No newline at end of file +- Press Cmd+F on macOS or Ctrl+F on Windows and Linux. From 8326089563298de57a09c2663ae459fd62e8e0bd Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:20:28 +1100 Subject: [PATCH 23/29] Update folders.md --- docs/essentials/folders.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/essentials/folders.md b/docs/essentials/folders.md index d363b4c..8aa3494 100644 --- a/docs/essentials/folders.md +++ b/docs/essentials/folders.md @@ -12,7 +12,7 @@ To create a folder, there are three methods, which are listed below: ## Moving Folders -Drag and drop the required folder onto another folder. +Drag and drop the required folder into another folder. ## Renaming and Deleting From 0455e76cbef97ebf5be6d294b55dcbc23612aad8 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:27:37 +1100 Subject: [PATCH 24/29] Update snippets.md --- docs/essentials/snippets.md | 31 +++++++++++-------------------- 1 file changed, 11 insertions(+), 20 deletions(-) diff --git a/docs/essentials/snippets.md b/docs/essentials/snippets.md index 291dd09..87ee665 100644 --- a/docs/essentials/snippets.md +++ b/docs/essentials/snippets.md @@ -16,30 +16,21 @@ Follow one of the following steps: In the bottom right corner of the editor press the current snippet language, by default it is **"Plain text"**, then select the language you need from the drop-down list. -## Moving Snippet +## Moving a Snippet -Drag and drop the snippet to the desired folder. +Drag and drop the snippet into the desired folder. -## Deleting Snippet +## Deleting a Snippet -Call the context menu by right-clicking on the snippet and selecting **"Delete "**. +Bring up the context menu by right-clicking on the snippet and selecting **"Delete"**. The snippet will be moved to "**Trash"**. If needed, you can restore the snippet by dragging it back into a folder. -> The snippet will be moved to "**Trash "**. Later you can return the snippet back by dragging it back to the desired folder. +## Copying a Snippet -## Copying Snippet +To copy a snippet, either click the button in the top right corner of the editor or press Shift+Cmd+C on macOS or Shift+Ctrl+C on Windows and Linux. -Follow one of the following steps: - -- Click button on the top right corner of the editor. -- Press Shift+Cmd+C on macOS or Shift+Ctrl+C on Windows or Linux. - -## Formatting Snippet - -Snippet formatting makes the snippet code formatted. - -Follow one of the following steps: - -- Select **"Editor"** > **"Format"** from the menu bar. -- Press Shift+Cmd+F on macOS or Shift+Ctrl+F on Windows or Linux. +## Formatting a Snippet -> Not all languages can be formatted at this time. \ No newline at end of file +Formatting a snippet in massCode is simple and easy to grasp. To format one, either select **"Editor"** > **"Format"** from the menu bar or press Shift+Cmd+F on macOS or Shift+Ctrl+F on Windows and Linux. +::: NOTE +Not all languages can be formatted at the moment. This will change in the future. +::: From 146c9b9ef4957d989f918a75be6d02f45ad4a225 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:31:58 +1100 Subject: [PATCH 25/29] Update sync.md --- docs/essentials/sync.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/essentials/sync.md b/docs/essentials/sync.md index aefe7d4..8dd1fcb 100644 --- a/docs/essentials/sync.md +++ b/docs/essentials/sync.md @@ -1,3 +1,3 @@ -# Sync +# Synchronization -massCode gives you the ability to move your snipe library to the right place on your computer. And so you can select folders of synchronization services such as iCloud Drive, Google Drive or Dropbox or other similar services and get the ability to synchronize your library on other computers. \ No newline at end of file +massCode offers the ability to move your snippet library to anywhere on your computer. Thus, you should be able to synchronize your library to other computers using a service such as Google Drive, iCloud, etc. From b8a2c61b9a07439f8d5602db3b0bc8b0eaf99f0c Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:42:30 +1100 Subject: [PATCH 26/29] Update tags.md --- docs/essentials/tags.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/essentials/tags.md b/docs/essentials/tags.md index dc29720..5169202 100644 --- a/docs/essentials/tags.md +++ b/docs/essentials/tags.md @@ -1,19 +1,21 @@ # Tags -Tags are another way to organize your snippets. Unlike folders, snippets can have many tags. +Tags are another way to organize your snippets and keep productive. -## Search for tagged snippets +## Searching for Tagged Snippets -Click on **"TAGS "** beside **"LIBRARY "** in the sidebar to go into tag view mode. Click on the tag that you want. +Click on **"TAGS"** besides **"LIBRARY"** in the sidebar to go into tag view mode. Within that, select any tag you want to view snippets in. -## Adding a tag +## Adding a Tag -Select the snippet in which you want to add a tag, then enter a tag name in the **"Add Tag "** field below the snippet name. +Select the snippet to which you want to add a tag, then enter a tag name in the **"Add Tag"** field below the snippet name. -> If a tag already exists, it will be displayed in the pop-up menu, you can select from it. Tags are unique and cannot be repeated. +> If a tag already exists, it will be displayed in a pop-up menu from which you can select the tag. Tags are unique and cannot have duplicates. -## Deleting Tag +## Deleting a Tag -Call the context menu by right-clicking on the tag and select **"Delete "**. +Bring up the context menu by right-clicking on the tag and selecting **"Delete"**. -> Delete the tag, delete it as well as all the snippets that used it. \ No newline at end of file +::: NOTE +Deleting a tag does not delete any snippets in it. +::: From c23b9d266476703801f5eedc08822726f1e30fae Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:45:48 +1100 Subject: [PATCH 27/29] Update README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 99a9f20..fd142cf 100644 --- a/README.md +++ b/README.md @@ -1 +1,7 @@ -# massCode documentaion \ No newline at end of file +# massCode documentaion + +This is the repository in which the massCode documentation is located (amazing, right?) + +# Contribution + +If you spot any spelling errors, incorrect instructions or generally unclear things, please feel free to fork this repository and open a pull request after you've made the necessary changes. From 9707096d2a2e8f065b1362bce87ceb5ca26ccb41 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:46:05 +1100 Subject: [PATCH 28/29] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fd142cf..9ba11ab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # massCode documentaion -This is the repository in which the massCode documentation is located (amazing, right?) +This is the repository in which the massCode documentation is located. # Contribution From 381d3a39cbe47f1dfb2e0b72e139a84b7cfa8e52 Mon Sep 17 00:00:00 2001 From: Rishi <61339465+monocoloured@users.noreply.github.com> Date: Thu, 12 Mar 2020 17:46:15 +1100 Subject: [PATCH 29/29] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9ba11ab..f5bdcff 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # massCode documentaion -This is the repository in which the massCode documentation is located. +This is the repository in which the massCode documentation is hosted. # Contribution