Skip to content

Commit 1ae25b7

Browse files
committed
Clean trailing spaces from documentation
Signed-off-by: Marko Lindqvist <[email protected]>
1 parent 95c2716 commit 1ae25b7

File tree

13 files changed

+65
-69
lines changed

13 files changed

+65
-69
lines changed

LICENSE.txt

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Freeciv-web is free and open source software. The Freeciv C server is released under
22
the GNU General Public License, while the Freeciv-web web client is released
3-
under the GNU Affero General Public License.
3+
under the GNU Affero General Public License.
44

55

6-
See also: https://www.copyright.gov/fls/fl108.pdf
7-
"Copyright does not protect the idea for a game, its name or title, or the method or
8-
methods for playing it. Nor does copyright protect any idea, system, method, device, or
9-
trademark material involved in developing, merchandising, or playing a game. Once a game
6+
See also: https://www.copyright.gov/fls/fl108.pdf
7+
"Copyright does not protect the idea for a game, its name or title, or the method or
8+
methods for playing it. Nor does copyright protect any idea, system, method, device, or
9+
trademark material involved in developing, merchandising, or playing a game. Once a game
1010
has been made public, nothing in the copyright law prevents others from developing another
11-
game based on similar principles. Copyright protects only the particular manner of an
11+
game based on similar principles. Copyright protects only the particular manner of an
1212
author's expression in literary, artistic, or musical form."
1313

1414

README.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ THE FREECIV-WEB PROJECT
66
[![Code Quality: Javascript](https://img.shields.io/lgtm/grade/javascript/g/freeciv/freeciv-web.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/freeciv/freeciv-web/context:javascript)
77
[![Total Alerts](https://img.shields.io/lgtm/alerts/g/freeciv/freeciv-web.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/freeciv/freeciv-web/alerts)
88

9-
Freeciv-web is an open-source turn-based strategy game. It can be played in any HTML5 capable web-browser and features in-depth game-play and a wide variety of game modes and options. Your goal is to build cities, collect resources, organize your government, and build an army, with the ultimate goal of creating the best civilization. You can play online against other players (multiplayer) or play by yourself against the computer. There is both a HTML5 2D version with isometric graphics and a 3D WebGL version of Freeciv-web.
9+
Freeciv-web is an open-source turn-based strategy game. It can be played in any HTML5 capable web-browser and features in-depth game-play and a wide variety of game modes and options. Your goal is to build cities, collect resources, organize your government, and build an army, with the ultimate goal of creating the best civilization. You can play online against other players (multiplayer) or play by yourself against the computer. There is both a HTML5 2D version with isometric graphics and a 3D WebGL version of Freeciv-web.
1010

1111
Freeciv-web is free and open source software. The Freeciv C server is released under the GNU General Public License, while the Freeciv-web client is released
1212
under the GNU Affero General Public License. See [License](LICENSE.txt) for the full license document.
@@ -37,27 +37,27 @@ Freeciv-Web consists of these components:
3737
* [Freeciv-web](freeciv-web) - a Java web application for the Freeciv-web client.
3838
This application is a Java web application which make up the application
3939
viewed in each user's web browser. The Metaserver is also a part of this module.
40-
Implemented in Javascript, Java, JSP, HTML and CSS. Built with maven and runs
40+
Implemented in Javascript, Java, JSP, HTML and CSS. Built with maven and runs
4141
on Tomcat 10 and nginx.
4242

4343
* [Freeciv](freeciv) - the Freeciv C server, which is checked out from the official
4444
Git repository, and patched to work with a WebSocket/JSON protocol. Implemented in C.
4545

4646
* [Freeciv-proxy](freeciv-proxy) - a WebSocket proxy which allows WebSocket clients in Freeciv-web
47-
to send socket requests to Freeciv servers. WebSocket requests are sent from Javascript
48-
in Freeciv-web to nginx, which then proxies the WebSocket messages to freeciv-proxy,
47+
to send socket requests to Freeciv servers. WebSocket requests are sent from Javascript
48+
in Freeciv-web to nginx, which then proxies the WebSocket messages to freeciv-proxy,
4949
which finally sends Freeciv socket requests to the Freeciv servers. Implemented in Python.
5050

5151
* [Publite2](publite2) - a process launcher for Freeciv C servers, which manages
52-
multiple Freeciv server processes and checks capacity through the Metaserver.
52+
multiple Freeciv server processes and checks capacity through the Metaserver.
5353
Implemented in Python.
5454

55-
* [pbem](pbem) is play-by-email support.
55+
* [pbem](pbem) is play-by-email support.
5656

5757
Freeciv WebGL
5858
-------------
5959
Freeciv WebGL is the 3D version, which uses the Three.js 3D engine. More info about the WebGL 3D version can be found for [developers](https://github.com/freeciv/freeciv-web/tree/develop/freeciv-web/src/main/webapp/javascript/webgl) and [3D artists](https://github.com/freeciv/freeciv-web/wiki/Contributing-Blender-models-for-Freeciv-WebGL).
60-
Developer: Andreas Røsdal [@andreasrosdal](http://www.twitter.com/andreasrosdal)
60+
Developer: Andreas Røsdal [@andreasrosdal](http://www.twitter.com/andreasrosdal)
6161

6262
Running Freeciv-web on your computer
6363
------------------------------------
@@ -88,9 +88,9 @@ like dos2unix after saving them.
8888

8989
### Running Freeciv-web with Vagrant on VirtualBox
9090

91-
Freeciv-web can be setup using Vagrant on VirtualBox to quickly create a
91+
Freeciv-web can be setup using Vagrant on VirtualBox to quickly create a
9292
local developer image running Freeciv-web on latest Ubuntu on your host
93-
operating system such as Windows, OSX or Linux.
93+
operating system such as Windows, OSX or Linux.
9494
This is the recommended way to build Freeciv-web on your computer.
9595

9696
1. Install VirtualBox: https://www.virtualbox.org/ - Install manually on Windows, and with the following command on Linux:
@@ -113,7 +113,7 @@ sudo apt-get install vagrant
113113

114114
4. Test Freeciv-web by pointing your browser to http://localhost if you run Windows or http://localhost:8080 if you run Linux or macOS.
115115

116-
To log in to your Vagrant server, run the command:
116+
To log in to your Vagrant server, run the command:
117117
```bash
118118
vagrant ssh
119119
```
@@ -128,7 +128,7 @@ Install this software if you are not running Freeciv-web with Vagrant:
128128

129129
- Tomcat 10 - https://tomcat.apache.org/
130130

131-
- Java 11 JDK - https://adoptopenjdk.net/
131+
- Java 11 JDK - https://adoptopenjdk.net/
132132

133133
- Python 3.6 - http://www.python.org/
134134

@@ -161,9 +161,9 @@ Install this software if you are not running Freeciv-web with Vagrant:
161161
When in a [tested system](scripts/install/systems),
162162
you may run `scripts/install/install.sh` and it will fetch and configure what's needed.
163163

164-
Start and stop Freeciv-web with the following commands:
165-
start-freeciv-web.sh
166-
stop-freeciv-web.sh
164+
Start and stop Freeciv-web with the following commands:
165+
start-freeciv-web.sh
166+
stop-freeciv-web.sh
167167
status-freeciv-web.sh
168168

169169
All software components in Freeciv-web will log to the /logs sub-directory of the Freeciv-web installation.
@@ -196,16 +196,16 @@ Freeciv-Web is built on GitHub actions on every commit. This is the current buil
196196
Developers interested in Freeciv-web
197197
------------------------------------
198198

199-
If you want to contibute to Freeciv-web, see the [issues](https://github.com/freeciv/freeciv-web/issues) on GibHub and the [TODO file](doc/TODO) for
200-
some tasks you can work on. Pull requests on Github is welcome!
201-
199+
If you want to contibute to Freeciv-web, see the [issues](https://github.com/freeciv/freeciv-web/issues) on GibHub and the [TODO file](doc/TODO) for
200+
some tasks you can work on. Pull requests on Github are welcome!
201+
202202

203203
Contributors to Freeciv-web
204204
---------------------------
205-
Andreas Røsdal [@andreasrosdal](https://github.com/andreasrosdal)
206-
Marko Lindqvist [@cazfi](https://github.com/cazfi)
207-
Sveinung Kvilhaugsvik [@kvilhaugsvik](https://github.com/kvilhaugsvik)
208-
Gerik Bonaert [@adaxi](https://github.com/adaxi)
209-
Lmoureaux [@lmoureaux](https://github.com/lmoureaux)
210-
Máximo Castañeda [@lonemadmax](https://github.com/lonemadmax)
205+
Andreas Røsdal [@andreasrosdal](https://github.com/andreasrosdal)
206+
Marko Lindqvist [@cazfi](https://github.com/cazfi)
207+
Sveinung Kvilhaugsvik [@kvilhaugsvik](https://github.com/kvilhaugsvik)
208+
Gerik Bonaert [@adaxi](https://github.com/adaxi)
209+
Lmoureaux [@lmoureaux](https://github.com/lmoureaux)
210+
Máximo Castañeda [@lonemadmax](https://github.com/lonemadmax)
211211
and the [Freeciv.org project](https://www.freeciv.org/wiki/People)!

blender/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Blender 3d models created for Freeciv-web.
33

44
![Freeciv-web](https://raw.githubusercontent.com/freeciv/freeciv-web/develop/freeciv-web/src/main/webapp/javascript/webgl/freeciv-webgl.png "Freeciv-web WebGL screenshot")
55

6-
These are the original Blender files for all 3D models in the WebGL version.
6+
These are the original Blender files for all 3D models in the WebGL version.
77

88
3D artists are welcome to improve these models!
99

@@ -12,7 +12,7 @@ Export from Blender to glTF 2.0 .glb binary format
1212

1313
Follow these steps to prepare the 3D models for usage in Freeciv-web:
1414

15-
1. Install and activate the Blender glTF 2.0 exporter
15+
1. Install and activate the Blender glTF 2.0 exporter
1616
https://github.com/KhronosGroup/glTF-Blender-Exporter
1717

1818
2. Export the blender file from Blender: File -> Export -> glTF 2.0 (.glb)
@@ -25,14 +25,14 @@ https://github.com/KhronosGroup/glTF-Blender-Exporter
2525
When creating new additional 3D-models they must also be added to preload.js in Freeciv-web so that they are preloaded correctly.
2626

2727
Be sure to limit the file size and number of verticies, since the result
28-
will be rendered in a web browser. Check the file size of the generated .glb file!
28+
will be rendered in a web browser. Check the file size of the generated .glb file!
2929

3030
Don't export any lights or cameras.
3131

3232
3D Models with textures
3333
=======================
3434

35-
See the citywalls.blend for an example of a 3D model with textures which works in Freeciv-web 3D.
35+
See the citywalls.blend for an example of a 3D model with textures which works in Freeciv-web 3D.
3636

3737

3838
The unit models come from here: http://opengameart.org/content/blender-models-for-freeciv-units

doc/CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ Thank you for your interest in contributing to Freeciv-web!
66

77
Freeciv is an open source project where contributions from the open source community is encouraged.
88
There are multiple versions of Freeciv-web, and Freeciv-web can be hosted on multiple server instances.
9-
To get involved in one of these Freeciv-web instances, you may either contribute directly to the
9+
To get involved in one of these Freeciv-web instances, you may either contribute directly to the
1010
github.com/freeciv/freeciv-web repository by submitting a pull-request there, or contact one of the fork projects
1111
of Freeciv-web on GitHub, IRC, e-mailing lists, Discord or similar.
1212

1313
## Multiple Freeciv-web servers
14-
We need to recognize that there are multiple competing Freeciv-web servers, and that the main
15-
freeciv/freeciv-web github repository must be generic and not specific to one site.
14+
We need to recognize that there are multiple competing Freeciv-web servers, and that the main
15+
freeciv/freeciv-web github repository must be generic and not specific to one site.
1616
We will get a better Freeciv-web service if we allow multiple servers to exists and compete.
1717

1818
## Pull Request Guidelines
1919

20-
- All changes to Freeciv-web must be done using Pull Requests on GitHub. Don't commit changes directly to the master or develop branch.
20+
- All changes to Freeciv-web must be done using Pull Requests on GitHub. Don't commit changes directly to the master or develop branch.
2121
- Pull requests must be approved by two other Freeciv developers. Minor changes can be approved by one Freeciv developer. If there's no objections within 72h to the pull request, it's ok to merge it.
2222
- Only freeciv maintainers team members have rights to merge commits.
2323
- Don't break the build. All tests run by GitHub actions must pass successfully.

freeciv-web/README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
Freeciv web application
1+
Freeciv web application
22
=======================
33

4-
This is the Freeciv web application, which consists of the Java servlets
4+
This is the Freeciv web application, which consists of the Java servlets
55
and filters for running the web client, JSP templates, javascript code
6-
and other web content.
6+
and other web content.
77

88
Derived Sources
99
===============
@@ -24,12 +24,12 @@ The build scripts are updated to build Freeciv-web for Tomcat by default,
2424
so setting up Freeciv-web with Vagrant will configure this automatically.
2525
Also see the suggested nginx.conf file in publite2/nginx.conf
2626

27-
https://tomcat.apache.org/
28-
http://nginx.org/
27+
https://tomcat.apache.org/
28+
http://nginx.org/
2929

3030
Build script
3131
============
32-
Use maven to build and deploy, by running this build script:
32+
Use maven to build and deploy, by running this build script:
3333
sh build.sh
3434

3535
There is also a build-js.sh script to build just JavaScript quickly for development work.
@@ -47,6 +47,5 @@ if you are not using vagrant or the install script:
4747
* freeciv-web/src/main/webapp/WEB-INF/config.properties (you can use config/web.properties.tmpl as a template)
4848

4949

50-
Copyright (C) 2007-2016 Andreas Røsdal.
50+
Copyright (C) 2007-2016 Andreas Røsdal.
5151
Released under the GNU AFFERO GENERAL PUBLIC LICENSE.
52-

freeciv-web/src/main/webapp/docs/help_intro.txt

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
<h1>The Freeciv Online Manual</h1>
22
<img src='/static/images/frontpage-jumbotron.png' style="max-width: 40%;"><br><br>
33

4-
Freeciv is a Free and Open Source empire-building strategy game inspired by the
5-
history of human civilization. The game commences in prehistory and your mission
4+
Freeciv is a Free and Open Source empire-building strategy game inspired by the
5+
history of human civilization. The game commences in prehistory and your mission
66
is to lead your tribe from the Stone Age to the Space Age...<br><br>
77
Freeciv-web is the HTML5 web-browser version of <a href="https://www.freeciv.org" target="_new">Freeciv</a>.
88
Freeciv-web is free and open source software, released under the <a href="https://www.gnu.org/licenses/agpl-3.0.html" target='_new'>
9-
GNU Affero General Public License</a>. The Freeciv C server is released under the
9+
GNU Affero General Public License</a>. The Freeciv C server is released under the
1010
<a href="https://www.gnu.org/licenses/gpl-2.0.html" target='_new'>GNU General
1111
Public License</a>. <br>
1212

1313
The HTML5 and 3D WebGL versions of Freeciv-web was initially created by <a href='http://www.twitter.com/andreasrosdal' target='_new'>
14-
Andreas R&oslash;sdal</a>. A huge list of people have contributed to the Freeciv project, see the full
14+
Andreas R&oslash;sdal</a>. A huge list of people have contributed to the Freeciv project, see the full
1515
<a href='https://www.freeciv.org/wiki/People' target='_new'>credits for
1616
Freeciv</a>. Freeciv-web is always looking for game developers to help improve
1717
the game!
+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
glTF 3D models for Freeciv WebGL
1+
glTF 3D models for Freeciv WebGL
22
================================
33

4-
This directory contains glTF 2.0 binary .glb files,
4+
This directory contains glTF 2.0 binary .glb files,
55
which have been exported from the /blender directory.
66

77

freeciv-web/src/main/webapp/javascript/webgl/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is the WebGL + Three.js renderer for Freeciv-web.
55

66
[Three.js](https://threejs.org/) is the 3D engine used in Freeciv-web.
77

8-
Custom GLSL Fragment and Vertex shaders can be found in the shaders subdirectory.
8+
Custom GLSL Fragment and Vertex shaders can be found in the shaders subdirectory.
99

1010
![Freeciv-web](https://raw.githubusercontent.com/freeciv/freeciv-web/develop/freeciv-web/src/main/webapp/javascript/webgl/freeciv-webgl.png "Freeciv-web WebGL screenshot")
1111

freeciv-web/src/main/webapp/javascript/webgl/shaders/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
WebGL Shaders for Freeciv-web
1+
WebGL Shaders for Freeciv-web
22
=============================
33

44
These are the WebGL fragment and vertex shaders used by Freeciv-web:
55

66
Terrain
77
=======
88
The terrain shaders implement the rendering of different tile terrain types
9-
on the game map.
9+
on the game map.
1010

11-
* terrain_vertex_shader.glsl
12-
* terrain_fragment_shader.glsl
11+
* terrain_vertex_shader.glsl
12+
* terrain_fragment_shader.glsl
1313

1414

1515
Labels

freeciv-web/src/main/webapp/static/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ The content was split for the following reasons:
99
2. Allows a developer to change a library without affecting the Freeciv-web client.
1010
3. Allows for an easier configuration of the minifiers.
1111

12-
So to summarize, resources for the Freeciv-web client go in the root directory, and resources for the site go in this directory.
12+
So to summarize, resources for the Freeciv-web client go in the root directory, and resources for the site go in this directory.
1313

pbem/README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,15 @@ Freeciv-pbem is automatically started by start-freeciv-web.sh script
1313
Python unit tests are found in test_pbem.py.
1414

1515
Required configuration:
16-
1. Put your Google ReCaptcha (https://www.google.com/recaptcha)
16+
1. Put your Google ReCaptcha (https://www.google.com/recaptcha)
1717
secret key in captcha-secret field here:
18-
freeciv-web\src\main\webapp\WEB-INF\web.xml
18+
freeciv-web\src\main\webapp\WEB-INF\web.xml
1919
and Google ReCaptcha client sitekey here:
2020
freeciv-web/src/main/webapp/javascript/pbem.js
2121

2222
2. Update settings.ini.dist with
2323
- SMTP username, password, host,port. The SMTP authentication can be gotten by creating an account at http://www.mailgun.com
24-
- MySQL username and password for the local MySQL instance.
24+
- MySQL username and password for the local MySQL instance.
2525
then rename this settings-file to settings.ini.
2626
- savegame_directory and ranklog_directory, which is where PBEM savegames and ranklog files are stored.
2727
(savegame_directory in this file should be set to the same value as save_directory in publite2/settings.ini.
28-
29-

publite2/README.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Freeciv-web Publite2
1+
Freeciv-web Publite2
22
====================
33

44
Publite2 is a process manager which launches multiple Freeciv-web servers
55
depending on demand reported by the Metaserver. It requires the Freeciv-web
6-
webapplication to be already running on Resin to work.
6+
webapplication to be already running on Resin to work.
77

8-
Publite2 also launches one Freeciv-proxy server instance for each
8+
Publite2 also launches one Freeciv-proxy server instance for each
99
Freeciv C server.
1010

1111
Publite2 is started automatically by the start-freeciv-web.sh script.
@@ -14,6 +14,5 @@ Requires Python 3.5 and the Freeciv C server built for Freeciv-web
1414
This process logs to logs/publite2.log file.
1515

1616
Publite2 has a HTTP status page which can be accessed at:
17-
http://localhost/pubstatus through nginx or
17+
http://localhost/pubstatus through nginx or
1818
http://localhost:4002/pubstatus directly.
19-

scripts/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Freeciv-web scripts
88
based on the Freeciv packets.def file.
99

1010
* freeciv-img-extract - extracts the images of the Freeciv tileset,
11-
and generates a version for the web. This produces a tileset PNG
12-
and Javascript.
11+
and generates a version for the web. This produces a tileset PNG
12+
and Javascript.
1313

1414
* start-freeciv-web.sh - starts Freeciv-web.
1515

0 commit comments

Comments
 (0)