Skip to content

Commit 1d727ee

Browse files
committed
documentation
1 parent 2f12f83 commit 1d727ee

2 files changed

Lines changed: 34 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,14 @@ results :
1919
| `build/fungraphics-dev.jar` | The latest build of the library, constant name, useful for testing. |
2020
| `build/libs/fungraphics-VERSION.jar` | The same file with a [versioned](#Version) name. |
2121

22-
## Running
23-
24-
```gradle run```
25-
2622
## Version
27-
The version number used in the file name and available using `FunGraphics.version()` is
28-
generated by inspecting the git state (see [com.palantir.git-version](https://github.com/palantir/gradle-git-version) for details).
23+
24+
The version number used in the file name and available using `FunGraphics.version()` is
25+
generated by inspecting the git state (see [com.palantir.git-version](https://github.com/palantir/gradle-git-version)
26+
for details).
2927

3028
Here is an example : 1.5.7-3-g2aabbbf.dirty
29+
3130
* 1.5.7 is the last tag
3231
* -3- we are 3 commits after the tag
3332
* g2aabbbf : git short hash
@@ -39,3 +38,4 @@ Here is an example : 1.5.7-3-g2aabbbf.dirty
3938
0. git tag -a MAJOR.MINOR.SUB -m "tag vMAJOR.MINOR.SUB"
4039
0. git push origin MAJOR.MINOR.SUB
4140
0. [compile](#Compiling)
41+

usage_intellij.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Use in IntelliJ IDEA
2+
3+
* Create a Scala project
4+
* Make sure the FunGraphics library is in your project
5+
* Download the FunGraphics [jar](https://github.com/hevs-isi/FunGraphics/releases/latest) and place it in project
6+
directory, at the same level as the `src` directory.
7+
* Your project directory should look like:
8+
```
9+
LabXX
10+
├── FunGraphics-M.m.p.jar
11+
└── src
12+
└── LabXX_TaskYY.scala
13+
```
14+
* Let _IntelliJ_ know about the library
15+
* Click on `File` > `Project Structure...`
16+
* Go in the `Project` > `Librairies` tab
17+
* Click on the `+` (`New Project Library`) > `Java`
18+
* Select the FunGraphics jar file inside your project > `OK`
19+
* `OK` to the message: "Library FunGraphics-M.m.p.jar will be added to the selected modules."
20+
* `OK` to close the `Project Structure...`
21+
* You can test the installation using that simple code which will display an empty window.
22+
```
23+
import hevs.graphics.FunGraphics
24+
25+
object FunGraphicsHello extends App{
26+
val fungraphics = new FunGraphics(300, 400)
27+
}
28+
```

0 commit comments

Comments
 (0)