Skip to content

Commit cb81b3e

Browse files
committed
new readme
1 parent 9f10a23 commit cb81b3e

File tree

2 files changed

+25
-18
lines changed

2 files changed

+25
-18
lines changed

.DS_Store

0 Bytes
Binary file not shown.

README.md

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,17 @@
22

33
![Preview](imgs/Toster.png)
44

5-
__Made for scientists by scientists__
5+
__Made for scientists by scientists__ ⚗️
66

7-
*Written for the freeware Wolfram Engine using JavaScript and [WLX](https://jerryi.github.io/wlx-docs/)*
7+
*written with love using freeware Wolfram Engine, JavaScript and [WLX](https://jerryi.github.io/wlx-docs/)*
88

9-
__[Documentation & Tutorials](https://jerryi.github.io/wljs-docs/)__
9+
__[Documentation & Tutorials](https://jerryi.github.io/wljs-docs/)__ 📚
1010

11-
__[Telegram support chat](https://t.me/+PBotB9UJw-hiZDEy)__
11+
__[Telegram support chat](https://t.me/+PBotB9UJw-hiZDEy)__ 💬
1212

13-
**Recommended Wolfram Engine: 13.3 or higher**
13+
**Recommended [Wolfram Engine](https://www.wolfram.com/engine/): 13.3 or higher**
1414

15-
__Special thanks to co-developer [@KirillBelovTest](https://github.com/KirillBelovTest) (Wolfram Language HTTP/WS Stack developer)__
15+
__Special thanks to our co-developer [@KirillBelovTest](https://github.com/KirillBelovTest) (Wolfram Language HTTP/WS Stack developer)__
1616

1717
To help maintain this project ❤️
1818
- [GitHub Sponsors](https://github.com/sponsors/JerryI)
@@ -21,7 +21,7 @@ To help maintain this project ❤️
2121
## Highlights
2222

2323

24-
### Not a typical Jupyter-like notebook environment
24+
### Not a typical Jupyter-like notebook environment 🧨
2525

2626
It supports dynamics, GUI building blocks, and powerful Mathematica syntax out of the box.
2727

@@ -31,36 +31,36 @@ It supports dynamics, GUI building blocks, and powerful Mathematica syntax out o
3131

3232
No more static graphics! Each primitive of `Graphics`/`Graphics3D` was recreated from scratch using `d3.js` and `THREE.js` libraries. Most native plotting functions of Mathematica are supported.
3333

34-
#### AI Assistant
34+
#### AI Assistant 🤖
3535
We deeply integrated ChatGPT, so that AI can have a read/write acccess to your notebook
3636

3737
![AAI](imgs/ASKAI%20optimizer.gif)
3838

39-
### Command Palette and GUI-in-Code Emulation
39+
### Command Palette and GUI-in-Code Emulation 🎨
4040
#### Inline Dynamic Tool for Tuning 2D/3D Positions
4141

4242
![ezgif com-optipng](https://github.com/JerryI/wolfram-js-frontend/assets/4111822/5f24d9d2-bd36-40df-85c8-c50cbc37a8cd)
4343

4444

45-
### Native Math Input in the Code Editor
45+
### Native Math Input in the Code Editor 🧮
4646
Write beautiful equations between lines of normal Wolfram Language expressions.
4747

4848
![Mathinput-ezgif com-optipng](https://github.com/JerryI/wolfram-js-frontend/assets/4111822/ebc2d83a-0d4d-49e4-a073-e112829a8d62)
4949

50-
### Compress to HTML
50+
### Compress to HTML 🗜️
5151
An entire notebook can be exported to a standalone `.html` file keeping all data inside. __No internet dependency, no additional software__ is required for viewing a notebook
5252

5353
![HTML-ezgif com-optipng](https://github.com/JerryI/wolfram-js-frontend/assets/4111822/855bae87-b8e2-4f3a-bfaa-d64e7c50f71e)
5454

5555

5656
Later, once opened using WLJS Notebook application, it is unpacked back to a normal editable format.
5757

58-
### Data-Driven Slides
58+
### Data-Driven Slides 🛝
5959
Make a presentation right from the notebook.
6060

6161
![slides](imgs/ezgif.com-optimize-15.gif)
6262

63-
### Real-Time Interactivity
63+
### Real-Time Interactivity ⏱️
6464
Follows the mouse pointer and performs complex calculations.
6565

6666
![](imgs/ezgif.com-optimize-5-55576aef6756b65dcc582b2f19964fa0.gif)
@@ -83,14 +83,17 @@ __There is no aim to fully copy Mathematica__ (it will never be possible), howev
8383

8484
- __Stability__ and speed
8585
- Independence from WRI
86-
- Portability (not PDF) - easy to share your work with someone outside the ecosystem __keeping your graphics interactive__ or embedded on a website
86+
- Portability (not PDF) - easy to share your work with someone outside the ecosystem __keeping your graphics interactive__ or embedded to a website
8787
- Event-based approach to dynamics - allow users to __build complex dynamic notebooks__ and to have clear control over all moving parts
8888
- Natural bridge between other languages - HTML as markup, WL for computations, and JS for stunning visuals
8989

90-
# Installation
91-
[The freeware Wolfram Engine](https://www.wolfram.com/engine/) is required (Version 13.3 is preferable).
90+
# Installation 🛠️
91+
[The freeware Wolfram Engine](https://www.wolfram.com/engine/) is required (Version 13.3 is preferable). Activation can be done later using WLJS Notebook App.
9292

93-
## Desktop App
93+
*a side note for Linux users*
94+
If you face any issues, try to install avahi daemon.
95+
96+
## Desktop App ✨
9497
Download from the __[releases](https://github.com/JerryI/wolfram-js-frontend/releases)__ section.
9598

9699
## Standalone Server
@@ -125,7 +128,11 @@ wolframscript -f Scripts/start.wls noautolaunch True
125128
wolframscript -f Scripts/start.wls bypasstest True
126129
```
127130

128-
## Shortcuts
131+
### A side note for servers with no desktop interface
132+
You might need to install the following (for `Image` and some other graphics to work properly) [libraries](https://support.wolfram.com/59044).
133+
134+
135+
## Shortcuts 🎬
129136
*working in both: browser and desktop application*
130137

131138
### UI

0 commit comments

Comments
 (0)