Skip to content

Commit

Permalink
Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Raathigesh committed Aug 29, 2021
1 parent e88cba7 commit d005d20
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
<img src="docs/assets/PaperBanner.png" />

## Paper
<br />
<br />

Paper is a code note taking tool for VSCode with some special features. The main motivation behind Paper is to build a tool that will let you keep directories, files, location info within a file somewhere faster to reach so it's easy to get back to them.
Paper is a note taking tool for VSCode. The motivation behind Paper is to build a tool that will let you keep directories, files, location info within a file somewhere faster to reach so it's easy to get back to them.

If you are working on a feature and switching between few files, a tool like Paper could will this a lot easier and eliminate the need for having to search for a file among the open tabs or scroll a file over and over looking for that function.

Expand All @@ -14,25 +15,27 @@ You can install the [extension](https://marketplace.visualstudio.com/items?itemN

<br />

### Guide to using paper

Here are few features of paper and how they might come in handy.
### Features and their use cases

#### Bookmark active file

<img src="docs/assets/Paper File bookmark.gif" />

If you click on the file icon in the floating menu, a bookmark for the active file will be created at the location of the cursor.
Click on the file icon in the floating menu to create a bookmark for the active file.

This is helpful if you want to bookmark a file that you frequently visit while implementing a feature.

<br />

#### Bookmark selection

<img src="docs/assets/Paper Selection bookmark.gif" />

If you select a text and click on the mouse icon in the floating menu, a bookmark to the selection will be created at the location of the cursor.
Select text in a file and click on the pointer icon in the floating menu to create a bookmark to the selection.

You could bookmark a few locations in your codebase that you jump around often. This could eliminate a lot of scrolling and searching for the tab among all the open tabs.
Using this feature you could bookmark any number of locations in your codebase you jump around often. This could eliminate a lot of scrolling and searching for the tab among all the open tabs.

<br />

#### File tree

Expand All @@ -41,3 +44,7 @@ You could bookmark a few locations in your codebase that you jump around often.
A file tree widget shows you the files under a particular path as a tree view.

This helps to keep a particular directory in-sight if don't want to keep expanding it in VSCode's tree view.

<br />

<br />

0 comments on commit d005d20

Please sign in to comment.