Skip to content

Commit 0419b79

Browse files
Updated Readme
Added math paragraph in usage, Mathjax credit and webfont credit
1 parent 9568ccc commit 0419b79

1 file changed

Lines changed: 14 additions & 5 deletions

File tree

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ All texts and numbers on the pages are able to be copied and pasted anywhere you
3232

3333
A button for getting back to the main page is provided on every profile page, directly below its title.
3434

35+
The equations page is intuitive to use: clicking the shape from the list on the left makes the math for that shape visible.
36+
Some other extra features from MathJax library are also available when right-clicking on a equation, like the ability of zooming the expression or copying the LaTex string for further use.
37+
3538
## Known bugs and issues
3639

3740
#### Ellipse perimeter not exact
@@ -41,6 +44,11 @@ Notice that the more "squished" the ellipse, the more imprecise the result.
4144
The formula has been updated to a better one - this one - in version 1.2 and the approximation is totally suitable for the intended use of this tool.
4245
This might mean that it won't be upgraded to an even more precise calculation (infinite series are not infinite in programming).
4346

47+
#### Truncated material names
48+
49+
When a material is selected from the dropdown menu, often the name overflows the space available.
50+
The issue will be solved in a future release.
51+
4452
## Next improvements to be added
4553

4654
Note: _The order of this list might not match the order these features will be added through next versions._
@@ -60,9 +68,9 @@ _Release date: July 25, 2021_
6068

6169
_Work Time: 11h 30min_
6270

63-
- Added equations page, showing formulas and symbols used in the tool
64-
- Changed the footer in a sidebar
65-
- Bugs can be reported via Github or Google module, from the "Credits" popup
71+
- Footer has been changed in a sidebar on the right
72+
- Added equations page showing formulas and symbols used in the tool
73+
- Bugs can be reported via Github or Google modules, from the "Credits" popup
6674

6775
#### v1.2
6876

@@ -98,8 +106,9 @@ First release composed by an index page and 13 standard shapes to choose. Tables
98106

99107
#### Libraries
100108
- [p5.js](https://p5js.org/) javascript library
101-
<!-- - [MathJax](https://www.mathjax.org/) javascript library -->
109+
- [MathJax](https://www.mathjax.org/) javascript library
102110

103111
#### Media
104112
- Favicon made by [Vitaliy Gorbachev](https://www.flaticon.com/authors/vitaly-gorbachev) from [www.flaticon.com](https://www.flaticon.com/)
105-
- Icons made by [Freepik](https://www.freepik.com) [www.flaticon.com](https://www.flaticon.com/)
113+
- Icons made by [Freepik](https://www.freepik.com) from [www.flaticon.com](https://www.flaticon.com/)
114+
- Web font icons from [UIcons](https://www.flaticon.com/uicons) on [www.flaticon.com](https://www.flaticon.com/)

0 commit comments

Comments
 (0)