README.md 2.71 KB
Newer Older
Anton Danilov's avatar
Anton Danilov committed
1
![Tablexia logo](https://gitlab.labs.nic.cz/labs/tablexia/raw/0efd78d10092b21472f8749ef673296502df034a/core/assets/common/screen/about/tablexia.png)
Anton Danilov's avatar
Anton Danilov committed
2

Anton Danilov's avatar
Anton Danilov committed
3
<br />
4 5
Tablexia is a modern educational application aiming to support the development of cognitive abilities. It is designed primarily for children with dyslexia in secondary schools. It should find its use in schools to supplement the standard teaching, as well as in pedagogical-psychological counseling offices and other counseling facilities for pupils with learning difficulties. 

6
## <b>Build</b>
7

8
Project is working with git submodule [Tablexia-Model](https://gitlab.labs.nic.cz/labs/tablexia-model). Before building the application, it needs to be called:
9

Matyáš Latner's avatar
Matyáš Latner committed
10
```
Matyáš Latner's avatar
Matyáš Latner committed
11
git submodule update --init --recursive
Matyáš Latner's avatar
Matyáš Latner committed
12
```
13 14

<br />
15 16
Tablexia can be build by running the command:

Anton Danilov's avatar
Anton Danilov committed
17 18 19
```
./gradlew build
```
20

21 22 23 24
This will build all versions of application (Android, iOS, desktop). It will work only on OS X systems, as iOS application can be build only there.
  <br />
<br />
For building specific version of application, run following commands:
25

26 27
<br />
<b>Android version</b> 
28

Anton Danilov's avatar
Anton Danilov committed
29 30 31
```
./gradlew android:build
```
32

33 34
<br />
<b>iOS version</b> 
35

Anton Danilov's avatar
Anton Danilov committed
36 37 38
```
./gradlew ios:build
```
39

40 41
<br />
<b>Desktop version</b> 
42

Anton Danilov's avatar
Anton Danilov committed
43 44 45
```
./gradlew desktop:build
```
46 47

<br />
48
Final result of building application for each platform are 2 build types: RELEASE and DEBUG.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

DEBUG version will show debug information on the screen.

## Gradle build parameters
File with build parameters should be located in `~/.gradle/gradle.properies`

<br />
<b>TABLEXIA_ASSETS_DOWNLOAD_URL</b>

URL address for downloading assets (textures, sounds...)

<br />

<b>TABLEXIA_ASSETS_UPLOAD_URL</b>

URL address for uploading assets, when application is built

<br />

<b>TABLEXIA_ASSETS_UPLOAD_USER</b>

User used for uploading assets

<br />

<b>TABLEXIA_SERVER_PROTOCOL</b>

Protocol of server

<br />

<b>TABLEXIA_SERVER_HOST</b>

Server host

<br />

<b>TABLEXIA_SERVER_PORT</b>

Server port

<br />

<b>TABLEXIA_SERVER_SECRET</b>

Password for the server

<br />

<b>TABLEXIA_SENTRY_DSN_DEBUG</b>

URL for Sentry server for collecting bugs, debug version

<br />

<b>TABLEXIA_SENTRY_DSN_RELEASE</b>

URL for Sentry server for collecting bugs, release version

<br />
Anton Danilov's avatar
Anton Danilov committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130

## <b>Assets</b>

All graphic assets in application are connected into several atlas files. These atlases are then packed into .zip files.
<br />
<br />

<b>Location of files:</b>
<br />

`tablexia/build/assets/src`
Original assets files


`tablexia/build/assets/dest`
Atlas files


`tablexia/build/assets/pack`
Packed .zip files

<br />
Anton Danilov's avatar
Anton Danilov committed
131
In order to have these assets in application, .zip files has to be copied into this folder:
Anton Danilov's avatar
Anton Danilov committed
132 133

`tablexia/android/assets/.tablexia_devel/download`
Anton Danilov's avatar
Anton Danilov committed
134 135 136

<br />
This applies only for desktop version.