Skip to content

Commit

Permalink
update desc
Browse files Browse the repository at this point in the history
  • Loading branch information
darkSheep404 authored Jun 20, 2023
1 parent c18b53e commit 02443e6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 7 deletions.
5 changes: 5 additions & 0 deletions roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,3 +52,8 @@ remark: 实现了在编辑器内渲染已经做过的笔记

---

参考
https://shields.io/badges/jet-brains-plugins
https://simpleicons.org/?q=idea
更新reademe

21 changes: 14 additions & 7 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,28 @@
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
<description><![CDATA[
A plugin which allow you to make notes for select codes,and click note to navigate to the code you selected to mark note,which will do helps to read and understand your project,and do notes base on code,you can sync nodes when change computer by copy the local data.sqllite file<br><br><br>
just use sheepNote plugin to select code, and make notes for them<br>
notes will be dispalyed in sheepNote toolsWindow <br>
you call search and manager your notes in sheepNote toolsWindow<br>
Besides, it will display some icon on the line where you make notes at <br>
<ul>
<li>select code to make note for them</li>
<li>noteTitle will display like comments</li>
<li>search,manage and view note and selected code in sheepNote toolsWindow</li>
<li>click notepath in noteDetail to navigate to code file and lineNumber</li>
<li>display icon on note line,click icon can navigate note in note list</li>
<ul>
<strong>notes will be stored at 'D:\sheepnote\data.sqllite' by default,</strong><br>
<strong>And due to this, this plugin cannot work on mac or win without "D:"</strong>
<strong>delete it will leads to note lost </strong>
<br>
<br>
<strong>if this plugin do help to you, or you have any suggestions,pls star/issue/pr in below github repo </strong><br>
<strong><a href ="https://github.com/darkSheep404/sheepNote">this github repository</a></strong><br>
<img src ="https://plugins.jetbrains.com/files/21869/preview_7a83b6d9-ef33-4d19-8cea-7b2b2cb41729"/><br>
<img src ="https://plugins.jetbrains.com/files/21869/preview_32d9d92b-40e6-4362-ad3f-d71923ea41d9"/><br>
<img src ="https://plugins.jetbrains.com/files/21869/screenshot_327df43d-74bd-4b56-9a47-7ea1e8377532"/><br>
<img src ="https://plugins.jetbrains.com/files/21869/screenshot_502b6238-908e-45cf-8698-3437266e7bef"/><br>
<img src ="https://plugins.jetbrains.com/files/21869/screenshot_62c7d590-a05e-4f85-92da-8f5925d184ae"/><br>
]]></description>
<change-notes>
Expand Down

0 comments on commit 02443e6

Please sign in to comment.