diff README.md @ 32:141f0a7d1986

Better error handling for npm dogfood command. Expand the README info.
author Ludovic Chabant <ludovic@chabant.com>
date Mon, 28 Nov 2022 20:39:13 -0800
parents 7975d7c73f8a
children b77a0dd22db8
line wrap: on
line diff
--- a/README.md	Thu Jul 14 14:47:04 2022 -0700
+++ b/README.md	Mon Nov 28 20:39:13 2022 -0800
@@ -1,4 +1,4 @@
-## Remember File State
+# Remember File State
 
 This [Obsidian](https://obsidian.md) plugin remembers the editor state of files
 as you switch between them. It restores the cursor position, scrolling position,
@@ -7,3 +7,20 @@
 
 Note that this plugin doesn't currently remember state across sessions.
 
+
+## Developer Quickstart
+
+My own workflow for working on this plugin is the following:
+
+1. Install the "_Remember File State_" plugin in a test vault. Don't forget to
+   enable it.
+2. Clone the `obsidian-remember-file-state` repository.
+3. Run the usual incantations, such as `npm install`.
+4. Run the build process in watch mode so that it compiles the TypeScript code
+   and overwrites the test vault's plugin: `npm run dogfood
+   /path/to/vault/.obsidian/plugins/obsidian-remember-state`.
+5. When making changes, trigger the "_Reload App Without Saving_" command to
+   reload Obsidian.
+6. Optionally, hit `Ctrl-Shift-I` to open the developer console and see the
+   console log.
+