#42558: civ2civ3: improve readme
Open Date: 2021-06-22 04:33
Last Update: 2021-06-23 03:26
URL for this Ticket:
https://osdn.net//projects/freeciv/ticket/42558
RSS feed for this Ticket:
https://osdn.net/ticket/ticket_rss.php?group_id=12505&tid=42558
---------------------------------------------------------------------
Last Changes/Comment on this Ticket:
2021-06-23 03:26 Updated by: bard
Comment:
Uploaded wip version for S3_0, where text is not wrapped.
Before I make the patches, I'd like to ask if it would be possible to keep this readme file unwrapped. I have seen that both clients qt and gtk include an auto-wrap feature when the readme is shown in game, that get a much better result (imo) than manually wrapping it, specially when the window size is smaller than the line size of the manual wrap. It is also much easier (imo) to edit the file, and to compare it to other versions, when the text is not wrapped.
In that case, I'd make a patch to unwrap the text, another for the text changes, and a 3th patch to rearrange some parts, so it is easier to compare them.
Else, if text must be wrapped, I'd like to ask if you use some automatic tool for this kind of readme files?
---------------------------------------------------------------------
Ticket Status:
Reporter: bard
Owner: (None)
Type: Patches
Status: Open
Priority: 5 - Medium
MileStone: (None)
Component: Rulesets
Severity: 5 - Medium
Resolution: None
---------------------------------------------------------------------
Ticket details:
I have been trying to improve a bit the readme of civ2civ3:
- Reserve the use of capital letters to words used as rule_names: units, techs, terrains, resources, buildings, governments, and some key game concepts like Food/Trade/Production, Science/Gold/Luxury, Shields/Bulbs/Coins...
- Use "Production" instead of "Shields" for city output (as in the city UI), or for production of citizens (like Trade, Luxury, Science and Gold), that will be multiplied by buildings.
- Keep using "Shields" for upkeep of units, use "Coins" instead of "Gold" for upkeep of units or buildings, and use "Bulbs" instead of "Science" for upkeep of techs.
This way, +1 Gold could mean +3 Coins if you have all economic buildings; +1 Production up to +2 Shields with all production buildings; +1 Science up to +4 Bulbs due to buildings and wonders.
However, +1 Shield, or Coin, or Bulb for upkeep of units, buildings, or techs will always remain +1.
- Use "upkeep in Food", instead of "Food upkeep". I'm not sure if better or not?
- Use "ground units" when they include all Land unit classes (big and small). Use "naval units" or "boats" when they include both Sea and Trireme.
- Use "unhappiness caused by military units", instead of Military Unhappiness, or simply war unhappiness.
- Clarify when wonders affect every city of every player, or only the cities of the owner.
I'm still working on it, so I'd thank other suggestions.
If you have noticed that I use to repeat the same mistakes while I write on english, it is a good moment to point it. It will make things easier for future updates of the readme or the helptexts. I already took note of the "same as" instead of "same than" fix.
--
Ticket information of Freeciv project
Freeciv Project is hosted on OSDN
Project URL: https://osdn.net/projects/freeciv/
OSDN: https://osdn.net
URL for this Ticket:
https://osdn.net/projects/freeciv/ticket/42558
RSS feed for this Ticket:
https://osdn.net/ticket/ticket_rss.php?group_id=12505&tid=42558