README.md 2.48 KB
Newer Older
Rémi BERTHO's avatar
Rémi BERTHO committed
1
2
Csuper
======
Rémi BERTHO's avatar
Rémi BERTHO committed
3
![Csuper logo](Images/Logo_200.png)
Rémi BERTHO's avatar
Rémi BERTHO committed
4

Rémi BERTHO's avatar
Rémi BERTHO committed
5

Rémi BERTHO's avatar
Rémi BERTHO committed
6
Csuper (Universal points counter allowing a dispense with reflection)
Rémi BERTHO's avatar
Rémi BERTHO committed
7

8
9
Informations
------------
Rémi BERTHO's avatar
Rémi BERTHO committed
10

Rémi BERTHO's avatar
Rémi BERTHO committed
11
This software allow you to count points easily with a computer.  
Rémi BERTHO's avatar
Rémi BERTHO committed
12
13
We can also save these games in a .csu file. (see documentation).

Rémi BERTHO's avatar
Rémi BERTHO committed
14
If you have any remarks or question on the use of csuper or on the code, don't hesitate to report to me.
Rémi BERTHO's avatar
Rémi BERTHO committed
15

Rémi BERTHO's avatar
Rémi BERTHO committed
16
You can find a lot of informations on [my website](https://www.dalan.fr).
17
18
19

Documentation
-------------
Rémi BERTHO's avatar
Rémi BERTHO committed
20

Rémi BERTHO's avatar
Rémi BERTHO committed
21
The documentation is made by Doxygen.  
Rémi BERTHO's avatar
Rémi BERTHO committed
22
23
You can create the documentation using the script `utility.sh`.
Run it without argument to see the help. You need latex installed to create the PDF doc.  
Rémi BERTHO's avatar
Rémi BERTHO committed
24
25
A file explain the .csu files.

26
27
Installation
------------
Rémi BERTHO's avatar
Rémi BERTHO committed
28

29
### Executables
Rémi BERTHO's avatar
Rémi BERTHO committed
30

Rémi BERTHO's avatar
Rémi BERTHO committed
31
Executables are available on [my website](https://www.dalan.fr).
Rémi BERTHO's avatar
Rémi BERTHO committed
32

33
### Compilation
Rémi BERTHO's avatar
Rémi BERTHO committed
34

Rémi BERTHO's avatar
Rémi BERTHO committed
35
To compile csuper you need a C++14 compliant compiler and the following libraries:
Rémi BERTHO's avatar
Rémi BERTHO committed
36

Rémi BERTHO's avatar
Rémi BERTHO committed
37
 * libxml++ ≥ 2.6
38
39
40
41
42
43
44
 * glibmm
 * giomm
 * muparser
 * PoDoFo
 * cairo
 * gettext
 * cmake
Rémi BERTHO's avatar
Rémi BERTHO committed
45
 * ncurses (for the CLI Unix version)
Rémi BERTHO's avatar
Rémi BERTHO committed
46
 * gtkmm3 ≥ 3.18 (for the GTK version)
Rémi BERTHO's avatar
Rémi BERTHO committed
47

Rémi BERTHO's avatar
Rémi BERTHO committed
48
If you are under Windows, you can use [MSYS2](https://msys2.github.io/) to get all the libraries.  
Rémi BERTHO's avatar
Rémi BERTHO committed
49
50
Then use:

51
52
53
```
git clone --recursive https://git.framasoft.org/Dalan94/Csuper.git
cd Csuper
Rémi BERTHO's avatar
Rémi BERTHO committed
54
cmake .
55
56
make
```
Rémi BERTHO's avatar
Rémi BERTHO committed
57

Rémi BERTHO's avatar
Rémi BERTHO committed
58
59
60
The followings arguments can be use with cmake:


Rémi BERTHO's avatar
Rémi BERTHO committed
61
```
Rémi BERTHO's avatar
Rémi BERTHO committed
62
63
64
65
66
67
-DLIB=FALSE				# To not compile libcsuper
-DCLI=FALSE				# To not compile csuper-cli
-DGTK=FALSE				# To not compile csuper-gtk
-DPORTABLE=TRUE			# To compile csuper as portable app
-DLIBXMLPP=3.0			# To compile with the 3.0 version of libxml++
-DALL_UPDATES=FALSE		# To not launch the update script which need pandoc, clang-format and gettext utilities
Rémi BERTHO's avatar
Rémi BERTHO committed
68
```
Rémi BERTHO's avatar
Rémi BERTHO committed
69

Rémi BERTHO's avatar
Rémi BERTHO committed
70
There are codeblocks or codelite project to managed the sources if you want but please use cmake first to configure the sources.  
Rémi BERTHO's avatar
Rémi BERTHO committed
71
72
If you are under Linux you can run the softwares with the scripts `run-csuper-cli.sh` and `run-csuper-gtk.sh`. On Windows just use the csuper-cli.exe and csuper-gtk.exe  
The software can also be run on a web browser through broadway using the `run-csuper-html.sh` and `csuper-html.bat` script.  
Rémi BERTHO's avatar
Rémi BERTHO committed
73

Rémi BERTHO's avatar
Rémi BERTHO committed
74
You can use the `utility.sh` script to:
Rémi BERTHO's avatar
Rémi BERTHO committed
75

Rémi BERTHO's avatar
Rémi BERTHO committed
76
77
78
79
80
* Updates the man pages
* Update and compile the translation
* Format the code
* Generate the documentation
* Install and uninstall
Rémi BERTHO's avatar
Rémi BERTHO committed
81

Rémi BERTHO's avatar
Rémi BERTHO committed
82
Launch it without arguments to see how to use it.
Rémi BERTHO's avatar
Rémi BERTHO committed
83

Rémi BERTHO's avatar
Rémi BERTHO committed
84

85
The compilation should work under Linux, Mac et Windows.
Rémi BERTHO's avatar
Rémi BERTHO committed
86

87
88
Additional Information
----------------------
89

Rémi BERTHO's avatar
Rémi BERTHO committed
90
If you have any remark, do not hesitate to open an issue.