Skip to content

Commit 3730751

Browse files
committed
Improve readme and close issue #17
1 parent d33c247 commit 3730751

File tree

3 files changed

+8676
-6
lines changed

3 files changed

+8676
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,25 @@
11
# jaspModuleTemplate
22

3-
This template repository is a starting point for developing a new module for JASP.
4-
It contains the necessary files and structure, plus a numbers of examples to get started.
3+
This template repository contains example functionality, which makes it an excellent starting point for developing a new JASP module.
4+
It contains the necessary files and structure, plus a numbers of examples to get started and to understand JASP's internals.
55

66
## How to use this repository
77

8-
Fork this template repository to your own GitHub account to start developing your module.
9-
You can then clone the repository to your local machine and start developing your module.
8+
1. Fork this template repository to your own GitHub account
9+
2. Clone it to your machine
10+
3. Open JASP and add it as a development module
1011

11-
The repository contains example functionality.
12-
Feel free to reuse and adapt the examples to your needs.
12+
### For newcomers
13+
14+
It is very illuminating to take a look at our examples **and** at the files that generate them.
15+
16+
For instance, the image below shows the different menus for the _"Using the interface"_ analysis, together with the files that generate them:
17+
18+
![](inst/img/JASP.png)
19+
20+
### For contributors
21+
22+
Feel free to reuse and adapt to your needs.
1323
Feel also free to remove the ones you don't need.
1424

1525
## Contributing back new module to JASP

inst/img/JASP.png

557 KB
Loading

0 commit comments

Comments
 (0)