Skip to content

Commit d6218e1

Browse files
committed
Update README
1 parent 51703d2 commit d6218e1

2 files changed

Lines changed: 17 additions & 13 deletions

File tree

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PhasePortrait-GUI
22

3-
PhasePortrait-GUI is a Graphical User Interface of our library [phaseportrait](https://github.com/phaseportrait/phaseportrait). Only 2D phase diagrams at supported at the moment.
3+
PhasePortrait-GUI is a Graphical User Interface of our library [PhasePortrait](https://github.com/phaseportrait/phaseportrait). Only 2D phase diagrams at supported at the moment, with no plans of adding additional features.
44

55
Its intention is to provide access for beginners in Python or in our library to this resource. But also allowing to get the Python equivalent code for futher and more complex uses.
66

@@ -9,27 +9,31 @@ In order to generate the plots and the Python code it is **necessary** that Pyth
99
```
1010
$ python
1111
```
12-
There are also Python libraries as numpy or matplotlib that are required. We recommend prior to use this program to run the following:
12+
And [PhasePortrait](https://github.com/phaseportrait/phaseportrait) must me installed in that Python. You can install it with
1313
```
1414
$ pytohn -m pip install phaseportrait
1515
```
16-
As it will install all the required additional dependencies.
16+
This will install all necesary dependencies required.
1717

18-
At the moment it is not mandatory to have phaseportrait installed.
18+
19+
# Installation
20+
Go to the [releases page](https://github.com/phaseportrait/phaseportrait-gui/releases) and download the aplication matching your computer architecture. When downloaded unzip the file.
21+
22+
If there is not a matching file you can [build](#how-to-build) it yourself.
1923

2024
# Documentation
2125
Please visit the [main documentation page](https://phaseportrait.github.io/) for more information.
2226

2327
Also, we encourage you to let us know any bugs, malfunctions, improvements or even feedback if you are a marvelous person.
2428

25-
## How to build
26-
_______________
27-
**This part is not complete**
2829

29-
For windows:
30+
# How to build
31+
This is only necesary if the computer architecture is not already in the [releases page](https://github.com/phaseportrait/phaseportrait-gui/releases).
32+
33+
34+
To build for the current machine you can build the aplication with
3035
```
3136
$ npm install
3237
$ npm run build
3338
```
34-
35-
The program will be located at `./dist/`.
39+
The program will be located at `./dist/`.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
"test": "echo \"Error: no test specified\" && exit 1",
88
"start": "electron .",
99
"scss": "node-sass --watch scss -o css",
10-
"pack:win64": "electron-packager . PhasePortrait --out=dist --arch=x64 --app-version=1.0.3 --icon=phaseportrait_icon.ico --overwrite",
11-
"pack:all": "electron-packager . PhasePortrait --all --out=dist --arch=x64 --app-version=1.0.3 --icon=icons/phaseportrait_icon.ico --overwrite",
12-
"build": "npm run pack:all"
10+
"pack:win64": "electron-packager . PhasePortrait --out=dist --arch=x64 --app-version=1.0.4 --icon=phaseportrait_icon.ico --overwrite",
11+
"pack:all": "electron-packager . PhasePortrait --all --out=dist --app-version=1.0.4 --icon=icons/phaseportrait_icon.ico --overwrite",
12+
"build": "electron-packager . PhasePortrait --out=dist --app_version=1.0.4 --icon=icons/phaseportrait_icon.ico --overwrite"
1313
},
1414
"repository": {
1515
"type": "git",

0 commit comments

Comments
 (0)