You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Contibutions are always welcome! We appreciate every help with this project, be it just submitting issues or feature requests, picking one up and working on it, making edits to the wiki or opening a pull request with a new feature or a bugfix, as it helps grow the project.
4
+
5
+
TL;DR:
6
+
7
+
- The `minAppVersion` should be kept up-to-date
8
+
9
+
## Rules
10
+
11
+
Because obsidian keeps an index of versions of the plugin and their respective minimum version requirements for obsidian itself, the `minAppVersion` field in `manifest.json` and the version of the dependency `obsidian` in `package.json` should be kept equal. The version should also reflect the lowest version of api under which the plugin will work. The dependency version in `package.json` is pinned to a single version.
12
+
13
+
Oh, and also: This project uses yarn, although it doesn't matter if you use another package manager so long as you don't commit the log and lock files to VCS. Just be sure to let us know of your choice of package manager if you encounter a problem.
Copy file name to clipboardExpand all lines: README.md
+14-53Lines changed: 14 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,74 +4,35 @@ A plugin for displaying mathematical graphs in obsidian.md.
4
4
5
5
> *Remember to star this plugin on [Github](https://github.com/leonhma/obsidian-functionplot) if you like it.*
6
6
7
-
## How to use
8
-
9
-
Since version `1.1.0` you can create plots via a handy GUI. Open the command palette and select `Obsidian Functionplot: Plot a function`. This opens a dialog where you can easily specify the options and functions to plot.
10
-
11
-
### Manual usage
12
-
13
-
1. Type:
14
-
15
-
~~~text
16
-
```functionplot
17
-
---
18
-
title: Graph
19
-
disableZoom: false
20
-
bounds: [-10, 10, -10, 10]
21
-
grid: true
22
-
xLabel: x
23
-
yLabel: y
24
-
---
25
-
26
-
f(x) = x^2
27
-
g(x) = 0.5*x^3+x^2-44
28
-
```
29
-
~~~
7
+
*This file only contains basic instructions to get you to using this plugin quickly. If you want a more detailed documentation, take a look at the [wiki](https://github.com/leonhma/obsidian-functionplot/wiki).*
30
8
31
-
*(The metadata header in this example contains all possible options, you don't usually have to specify all of them)*
32
-
33
-
2. This will create a coordinate system with bounds `-10 < x < 10, -10 < y < 10` and plot the functions f and g. If you havent disabled it, you can even drag and zoom the graph.
3. This will create a coordinate system with bounds `-10 < x < 10, -10 < y < 10` and plot the functions f and g. If you havent disabled it, you can even drag and zoom the graph.
If you have any questions about the usage of the plugin, take a look at the [wiki](https://github.com/leonhma/obsidian-functionplot/wiki) or post a question in the [discussions](https://github.com/leonhma/obsidian-functionplot/discussions).
63
28
64
29
## Bugs and Errors
65
30
66
-
If you encounter any errors while using this plugin, please follow these steps:
31
+
If you encounter any errors while using this plugin, please report them to us. To do so, click [this link](https://github.com/leonhma/obsidian-functionplot/issues/new?assignees=leonhma&labels=bug&template=BUG_REPORT.yml), fill out the form as best as you can and click `Submit new issue`. These issues are publically viewable, so please don't submit any personal information.
32
+
33
+
## Contributing
67
34
68
-
1. Make sure you have followed the syntax as described above.
69
-
2. Ensure that you are using the latest version of this plugin. Do this by going to the "Community plugins" tab in the settings, and clicking "Check for updates".
70
-
3. If the issue still persists, please report it on GitHub. (If you managed to solve this problem on your own, but think we should know about it, please file the fitting type of issue.)
71
-
1. Go to the "Issues" tab of the repo.
72
-
2. Search for your error. If you can find it, chime in to the converation and let us know that it happened to you too. It appears this is a known issue and it is currently being worked on.
73
-
3. If you can't find it, open a new issue. Do this by clicking the "New issue" button in the top right. Select "Bug report".
74
-
4. Fill out the issue with as much information as you can. Your issue will be resolved in the near future.
35
+
Contributions are always welcome! Be it submitting issues, editing the wiki or creating a pull request, contributions by people like you help keep the project evolving. Please adhere to the [contributing guidelines](CONTRIBUTING.md).
0 commit comments