Skip to content

Commit

Permalink
Updated instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
claudiahauff committed Jan 5, 2023
1 parent 7574ff3 commit 341e6e6
Show file tree
Hide file tree
Showing 3 changed files with 3,331 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,15 @@ This plugin was created in one evening, it works but is brittle. Only created an

## Manually installing the plugin

1. Head to your vault folder and traverse into the plugin directory: `~obsidian-vault/.obsidian/plugins/`.
1. Head to your vault folder (the following command assumes it is in your home directory) and traverse into the plugin directory: `~/obsidian-vault/.obsidian/plugins/`.
2. Create a new directory called `paper-note-filler`.
3. Copy over `main.js`, `styles.css`, `manifest.json` to the just created directory.
4. Restart Obsidian.
5. Open the settings tab of Obsidian. You should see the `Paper Note Filling` plugin listed under Community Plugins.

## Using the plugin

1. Open the settings tab of Obsidian. You should see the `Paper Note Filling Plugin` listed under Community Plugins. There are two settings to consider: the folder in which to create the notes and the naming convention for each note.
1. Open the settings tab of Obsidian. You should see the `Paper Note Filling` plugin listed under Community Plugins. If not, make sure that There are two settings to consider: the folder in which to create the notes and the naming convention for each note.
2. Now whenever you want to create a note based on an arXiv URL, open the command palette, find the `Create paper note from an arXiv.org URL.` and then paste the arXiv URL into the input field. Press <kbd>Enter</kbd> and a note with the paper title, authors, url, abstract, etc. should be created. If the file already exists, it will not be overwritten.

## Develop it further yourself
Expand Down
2 changes: 1 addition & 1 deletion manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"id": "paper-note-filler",
"name": "Paper Note Filling Plugin",
"name": "Paper Note Filling",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Take an arxiv.org URL and automatically create an Obsidian note from it.",
Expand Down
Loading

0 comments on commit 341e6e6

Please sign in to comment.