Skip to content

Commit

Permalink
📝 (readme): Add links to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vict0rsch committed Nov 21, 2023
1 parent 0108d04 commit a09b1a8
Showing 1 changed file with 29 additions and 17 deletions.
46 changes: 29 additions & 17 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,36 +102,54 @@ Share ideas 💡 in [issues](https://github.com/vict0rsch/PaperMemory/issues) an
* [Sci-Hub](#ad-hoc-pdfs)
* [Add more](https://github.com/vict0rsch/PaperMemory/issues/13)

[About finding published papers from preprints](#preprints)
[[📑] About finding published papers from preprints](https://papermemory.org/features/#preprint-matching)

## Privacy

All the data collected is stored locally on your computer and you can export it to `json` it from the options page.

[[📑] More on Privacy](https://papermemory.org/features/#privacy)

## Feature requests

I'm regularly adding feature ideas in the [issues](https://github.com/vict0rsch/PaperMemory/issues). Feel free to go upvote the ones you'd like to see happen or submit your own requests.

## Customization

Customize features in the menu:
Checkout [[📑] All configuration options](https://papermemory.org/configuration/). Here's a quick overview:

**a.** Customize features in the menu:

<p align="center">
<img width="400" src="https://github.com/vict0rsch/PaperMemory/blob/master/extra/imgs/menu_concat.png?raw=true">
</p>

Switch between Light and Dark mode
**b.** Switch between Light and Dark mode

<p align="center">
<img src="https://github.com/vict0rsch/PaperMemory/blob/master/extra/imgs/lightdark.png?raw=true">
</p>

**c.** Advanced options

In the extension's [[📑] `options`](https://papermemory.org/configuration/#advanced-options) (right click on the icon or in the popup's menu) you will find advanced customization features:

* **Auto-tagging**: add tags to papers based on regexs matched on authors and titles
* **Source filtering**: filter out some paper sources you don't want to record papers from
* **Custom title function**: provide Javascript code to generate your own web page titles and pdf filenames based on a paper's attributes
* **Data management**: export/load your memory data and export the bibliography as a `.bib` file
* **Online Synchronization**: use Github Gists to sync your papers across devices

<p align="center">
<img src="https://raw.github.com/vict0rsch/PaperMemory/master/extra/imgs/opt_concat.png?raw=true">
</p>


## Keyboard Shortcuts

Use `cmd/ctrl+shift+e` to open PaperMemory.

See other [[📑] other keyboard shortcuts and how to customize them](https://papermemory.org/configuration/#keyboard-shortcuts), and [[📑] keyboard navigation](https://papermemory.org/configuration/#keyboard-navigation).

## User Guides

Expand All @@ -143,22 +161,10 @@ Switch between Light and Dark mode
<img src="https://raw.github.com/vict0rsch/PaperMemory/master/extra/imgs/guide-memory.png?raw=true">
</p>

## Advanced

In the extension's `options` (right click on the icon or in the popup's menu) you will find advanced customization features:

* **Auto-tagging**: add tags to papers based on regexs matched on authors and titles
* **Source filtering**: filter out some paper sources you don't want to record papers from
* **Custom title function**: provide Javascript code to generate your own web page titles and pdf filenames based on a paper's attributes
* **Data management**: export/load your memory data and export the bibliography as a `.bib` file
* **Online Synchronization**: use Github Gists to sync your papers across devices

<p align="center">
<img src="https://raw.github.com/vict0rsch/PaperMemory/master/extra/imgs/opt_concat.png?raw=true">
</p>

## Install from source

Refer to [[📑] the documentation](https://papermemory.org/getting-started/#from-source).

## Preprints

There currently exists, to my knowledge, no centralized source for matching a preprint to its subsequent published article. This makes it really hard to try and implement best practices in terms of citing published papers rather than their preprint.
Expand All @@ -167,13 +173,19 @@ My approach with PaperMemory is to try and notify you that a publication likely

There's room for improvement here^, please contact me (an issue will do) if you want to help.

More on preprint matching [[📑] in the documentation](https://papermemory.org/features/#preprint-matching).

## Discovering Code repositories

PaperMemory uses the PapersWithCode API in order to discover code repositories 🖥️

See [[📑] how it works](https://papermemory.org/features/#code-repositories).


## FAQ

[[📑] Frequently asked questions](https://papermemory.org/faq/).

## Todo

* [ ] Improve `Contributing.md`
Expand Down

0 comments on commit a09b1a8

Please sign in to comment.