Skip to content

implemented installation guide to README.md #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,21 @@ f(x)=E+log(x)*2

To see the complete list of supported math functions, please check the [wiki](https://github.com/leonhma/obsidian-functionplot/wiki).

## How to Install

1. ```` git clone https://github.com/leonhma/obsidian-functionplot /path/to/.obsidian/.plugins/
2. ```` cd /path/to/.obsidian/.plugins/ ````
2. ```` npm install ````
3. ```` npm run build ````
4. Open Obsidian, go to Settings → Community Plugins, and Enable the plugin.

## ⚙ Plugin Settings

Since version `1.2.0` there's a dedicated settings page for this plugin. Here you can adjust things like font sizes for the text elements of the plot, line widths and various colors. To access this page, head to the obsidian settings and scroll down the list to 'Community Plugins > Obsidian Functionplot'.

![Settings Page](https://github.com/leonhma/obsidian-functionplot/blob/master/images/settings/dark.png)

> **Note**
> **Note**
> For changes to be applied, Obsidian needs to "re-render" the chart. You can either restart Obsidian, or switch between view modes (eg. Reading mode > Edit mode > Reading mode).

---
Expand Down