You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+39-21Lines changed: 39 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,28 +5,30 @@
5
5
6
6
**RoboCup Soccer Simulator Monitor** (rcssmonitor) is used to view the simulation as it takes place by connecting to the [RoboCup Soccer Simulator Server](https://github.com/rcsoccersim/rcssserver) (rcssserver) or to view the playback of a simulation by loading game log files.
7
7
8
-
## ⚽️ Quick Start
8
+
## :soccer: Quick Start
9
9
10
-
rcssmonitor is implemented by C++ and depends [Boost](https://www.boost.org/) and [Qt](https://www.qt.io/).
10
+
rcssmonitor is implemented by C++14 and depends [Qt5](https://www.qt.io/).
11
11
At first, related tools have to be installed on the system.
12
-
In the case of Ubuntu 16.04 or 18.04, execute the following commands:
12
+
In the case of Ubuntu 18.04 or 20.04, execute the following commands:
Then, clone the repository. From its directory, execute commands:
20
20
21
-
```
22
-
autoreconf -i
21
+
```bash
22
+
./bootstrap
23
23
./configure
24
24
make
25
25
```
26
26
27
-
Alternatively you can download the tarball from [releases section](https://github.com/rcsoccersim/rcssmonitor/releases), extract it and run from its contents:
27
+
Alternatively you can download the tarball from the [releases section](https://github.com/rcsoccersim/rcssmonitor/releases), extract it and run from its contents:
28
28
29
-
```
29
+
```bash
30
+
tar xzvfp rcssmonitor-x.x.x.tar.gz
31
+
cd rcssmonitor-x.x.x
30
32
./configure
31
33
make
32
34
```
@@ -35,7 +37,7 @@ This will built the necessary binaries to get you up and running. `rcssmonitor/s
35
37
36
38
The version 16.0.0 or later support [CMake](https://cmake.org/). If CMake is prefered or problems with the above procedure, try the following commands:
37
39
38
-
```
40
+
```bash
39
41
mkdir build
40
42
cd build
41
43
cmake ..
@@ -45,54 +47,70 @@ make
45
47
In this case, `rcssmonitor/build/rcssmonitor` will be the binary for the monitor.
46
48
47
49
48
-
## 🛠 Configuring & Building
50
+
## :hammer_and_wrench: Configuring & Building
49
51
50
-
Before you can build RoboCup Soccer Simulator Monitor you will need to run the `configure` script located in the root of the distribution directory.
52
+
Before building rcssmonitor you will need to run the `configure` script located in the root of the distribution directory.
51
53
52
54
The default configuration will set up to install the monitor components in the following location:
53
55
54
56
`/usr/local/bin` for the executables
55
57
56
58
You may need administrator privileges to install the monitor into the default location. This locations can be modified by using configure's `--prefix=DIR` and related options. See `configure --help` for more details.
59
+
```bash
60
+
./configure --prefix=YOUR_INSTALLATION_DIR
61
+
```
57
62
58
63
The monitor has several features that can be enabled or disabled at configure time by using the `--enable-FEATURE[=ARG]` or `--disable-FEATURE` parameters to `configure`. `--disable-FEATURE` is equivalent to `--enable-FEATURE=no` and `--enable-FEATURE` is equivlant to `--enable-FEATURE=yes`. The only valid values for `ARG` are `yes` and `no`.
59
64
60
65
Once you have successfully configured the monitor, simply run `make` to build the sources.
61
66
62
67
If CMake is chosen, `ccmake` command is available for the configuration:
63
68
64
-
```
69
+
```bash
65
70
cd build
66
71
ccmake ..
67
72
```
68
73
74
+
## :package: Installing
69
75
70
-
## 📦 Installing
76
+
When you have completed building the monitor, it's components can be installed into their default locations or the locations specified during configuring by running
77
+
```bash
78
+
make install
79
+
```
80
+
Depending on where you are installing the monitor, you may need special permissions.
71
81
72
-
When you have completed building the monitor, it's components can be installed into their default locations or the locations specified during configuring by running `make install`. Depending on where you are installing the monitor, you may need special permissions.
82
+
## :wastebasket: Uninstalling
83
+
In the case of autotools, the monitor can also be easily removed by entering the distribution directory and running
84
+
```bash
85
+
make uninstall
86
+
```
87
+
This will remove all the files that where installed, but not any directories that were created during the installation process.
88
+
89
+
In the case of CMake, find `install_manifest.txt` under the build directory, then execute:
90
+
```bash
91
+
xargs rm < install_manifest.txt
92
+
```
73
93
74
-
The monitor can also be easily removed by entering the distribution directory and running `make uninstall`. This will remove all the files that where installed, but not any directories that were created during the installation process.
75
94
76
-
## ⏯ Using the Monitor
95
+
## :play_or_pause_button: Using the Monitor
77
96
78
97
To start the monitor either type
79
98
80
-
```
99
+
```bash
81
100
./rcssmonitor
82
101
```
83
102
84
103
from the directory containing the executable or
85
104
86
-
```
105
+
```bash
87
106
rcssmonitor
88
107
```
89
108
90
109
If you invoke `rcssmonitor` with `--help` option, available options are displayed in your console.
91
110
92
-
## ✉ ️Contributing
111
+
## :incoming_envelope: Contributing
93
112
94
113
For bug reports, feature requests and latest updates, please goto
95
114
https://github.com/rcsoccersim/rcssmonitor and open an issue or a pull request.
0 commit comments