diff options
Diffstat (limited to 'src')
-rw-r--r-- | src/docs/dev.md | 47 |
1 files changed, 43 insertions, 4 deletions
diff --git a/src/docs/dev.md b/src/docs/dev.md index 2a40e1b..bae64aa 100644 --- a/src/docs/dev.md +++ b/src/docs/dev.md | |||
@@ -1,14 +1,24 @@ | |||
1 | --- | 1 | --- |
2 | title: "Wall-J Devel. notes" | 2 | title: "BSc IN S5 / OOP with Java / Wall-J / Wall-J / Devel. notes" |
3 | author: [Pacien TRAN-GIRARD, Adam NAILI] | 3 | author: [Pacien TRAN-GIRARD, Adam NAILI] |
4 | date: 2017-12-09 | 4 | date: 2018-01-03 |
5 | ... | 5 | ... |
6 | 6 | ||
7 | # Project description | 7 | # Preamble |
8 | |||
9 | "Wall-J: the Space Cleaner" is a game in which a player uses bombs to push garbage into trash cans in user definable | ||
10 | worlds. | ||
11 | |||
12 | Being part of the "OOP with Java" course at [UPEM](http://www.u-pem.fr/), this application has been entirely | ||
13 | written in Java and makes use of the Zen5 and [JBox2D](http://www.jbox2d.org/) libraries. | ||
8 | 14 | ||
9 | ## Licensing | 15 | ## Licensing |
10 | 16 | ||
11 | ## Credits | 17 | This work is licensed under the terms of the |
18 | [Creative Commons BY-NC-SA 4.0 license](https://creativecommons.org/licenses/by-nc-sa/4.0/) by its authors: | ||
19 | Pacien TRAN-GIRARD and Adam NAILI. | ||
20 | |||
21 | Build-time and embedded run-time dependencies of this program are licensed under their own respective terms. | ||
12 | 22 | ||
13 | --- | 23 | --- |
14 | 24 | ||
@@ -16,14 +26,43 @@ date: 2017-12-09 | |||
16 | 26 | ||
17 | ## Building the project | 27 | ## Building the project |
18 | 28 | ||
29 | TODO: | ||
30 | |||
31 | - compilation done through ant | ||
32 | - needs jdk >= 8 | ||
33 | - dependencies included in the jar | ||
34 | |||
19 | ## Running the program | 35 | ## Running the program |
20 | 36 | ||
37 | See the user manual. | ||
38 | |||
21 | --- | 39 | --- |
22 | 40 | ||
23 | # Implementation details | 41 | # Implementation details |
24 | 42 | ||
43 | ## Considerations | ||
44 | |||
45 | ### Specification refinement | ||
46 | |||
47 | TODO: | ||
48 | |||
49 | - specs not clear in every possible way | ||
50 | - refined as such: world is made of tiles some of which defined traversable, defined coniditons of validity of a map | ||
51 | - see user manual | ||
52 | |||
53 | ### Unit testing | ||
54 | |||
55 | TODO: | ||
56 | |||
57 | - tests are necessary | ||
58 | |||
25 | ## Modules | 59 | ## Modules |
26 | 60 | ||
61 | TODO: | ||
62 | |||
63 | - class diagram | ||
64 | - package and class roles outline | ||
65 | |||
27 | ## Additional features | 66 | ## Additional features |
28 | 67 | ||
29 | ## Notes | 68 | ## Notes |