diff --git a/docs/README.md b/docs/README.md index 0634a3c..3d60158 100644 --- a/docs/README.md +++ b/docs/README.md @@ -77,17 +77,19 @@ Clone this repository to acquire the powershell script. 1. It is advised that you install Onetastic and the attached macro, which will automatically expand any collapsed paragraphs in the notebook. They won't be exported otherwise. * To install the macro, click the New Macro Button within the Onetastic Toolbar and then select File -> Import and select the .xml macro included in the release. * Run the macro for each Notebook that is open -1. Open a PowerShell terminal and navigate to the folder containing the script and run it. +1. It is highly recommended that you use VS Code, and its embedded Powershell terminal, as this allows you to edit and run the script, as well as check the results of the .md output all in one window. +1. Whatever you choose, open a PowerShell terminal and navigate to the folder containing the script and run it. ```'.\ConvertOneNote2MarkDown-v2.ps1'``` - if you receive an error, try running this line to bypass security: + * if you receive an error, try running this line to bypass security: "Set-ExecutionPolicy Bypass -Scope Process" - -1. It will ask you for the path to store the markdown folder structure. Please use an empty folder. + * if you still have trouble, try running both Onenote and Powershell as an administrator. + +1. It will ask you for the path to store the markdown folder structure. Please use an empty folder. If using VS Code, you might not be able to paste the filepath - right click on the blinking cursor and it will paste from clipboard. **Attention:** use a full absolute path for the destination -1. Read the prompts carefully to select your desired options. If you aren't actively editing your pages in Onenote, it is HIGHLY recommended that you don't delete the intermediate word docs, as they take 80+% of the time to generate. You can then quickly re-run the script with different parameters until you find what you like. +1. Read the prompts carefully to select your desired options. If you aren't actively editing your pages in Onenote, it is HIGHLY recommended that you don't delete the intermediate word docs, as they take 80+% of the time to generate. They are stored in their own folder, out of the way. You can then quickly re-run the script with different parameters until you find what you like. 1. Sit back and wait until the process completes 1. To stop the process at any time, press Ctrl+C. 1. If you like, you can inspect some of the .md files prior to completion. If you're not happy with the results, stop the process, delete the .md and media folders and re-run with different parameters.