Update README.md

README.md

@@ -19,7 +19,7 @@ So far, the dashboard shows information about:
   - Population: number of pops, species demographics
   - Factions: size, support and happiness of each faction
   - Military: fleet strength
-  - Galactic History: Interactive, historical map that shows the past state of the galaxy in the
+  - Galactic History: Interactive, historical map that shows which country owned which system at any given time
 
 ## Event Ledger
 
@@ -34,7 +34,7 @@ Currently, this is a list of wars with detailed combat logs, and for each of you
   - Passed edicts, researched technologies, embraced traditions and ascension perks
   - Planet colonizations
 
-There is a lot more that can be done with this in the future!
+Much more can be done with this in the future!
 
 ## How it works
 
@@ -86,24 +86,23 @@ These instructions should also work on Mac OS X, although I cannot test this or
 
 # Instructions
 
-If you just want the basics, run the `stellarisdashboard` command while you play the game and it should do everything for you.
+If you just want the basics, run the program while you play the game, either with `stellarisdashboard.bat` on Windows, or by running `stellarisdashboard` in a command line.
 
-While `stellarisdashboard`  is running, you can open the in-game browser with the [help button in the lower right corner of the game UI](https://imgur.com/zWPmrbr), or by pressing the shortcut Alt-B. Then, there should be three buttons in the top right corner of the browser window. Clicking these buttons should let you navigate to the various features of the dashboard. Alternatively, you can use your regular web browser to view the dashboard at [http://127.0.0.1:28053/](http://127.0.0.1:28053/) without installing the mod.
+While `stellarisdashboard` is running, you can open the in-game browser with the [help button in the bottom right corner of the game UI](https://imgur.com/zWPmrbr), or with the shortcut Alt-B. Then, there should be several buttons in the top right corner of the browser window. Click these to navigate to the various features of the dashboard. Alternatively, you can use any web browser to view the dashboard at [http://127.0.0.1:28053/](http://127.0.0.1:28053/) without installing the mod.
 
 ## Command Line Interface
 
 The command line interface allows you to:
 
-  - Only run the save monitoring without any interactivity. This only builds the database, which you can later visualize (`stellarisdashboardcli monitor_saves`)
-  - Produce the static visualizations (`stellarisdashboardcli visualize`)
-  - Reparse all existing files. Running `stellarisdashboard` or `stellarisdashboardcli monitor_saves` will ignore any existing save files,
-  so sometimes it may be necessary to manually re-parse them. (`stellarisdashboardcli parse_saves`)
+  - Only run the save monitoring without any interactivity. This only builds the database, which you can later visualize (command `stellarisdashboardcli monitor_saves`)
+  - Produce the static visualizations (command `stellarisdashboardcli visualize`)
+  - Reparse all existing files. Running `stellarisdashboard` or `stellarisdashboardcli monitor_saves` will ignore existing save files, so sometimes it may be necessary to manually re-parse them. (command `stellarisdashboardcli parse_saves`)
 
-Any parameters provided to these commands override the values set in the `config.ini` file.
+Parameters provided to these commands override the values set in the `config.ini` file.
 
 ## Configuration
 
-The following parameters can be set in the `src/stellarisdashboard/config.ini` file:
+The following parameters (and maybe a few more) can be set in the `src/stellarisdashboard/config.ini` file:
 
   - `save_file_path`: The path where your save files are.
   - `base_output_path`: The path where any files generated by the dashboard are stored. This includes the database files and any images you generate with the `stellarisdashboardcli visualize` command.
@@ -112,7 +111,7 @@ The following parameters can be set in the `src/stellarisdashboard/config.ini` f
   - `port`:  The port where the interactive dashboard is served. If you change this, you should adapt the URL in the `mod/Timeline/interface/browser.gui` file accordingly.
   - `show_everything`: Set to `True` if you want to see the data of all empires.
   - `only_show_default_empires`: Set to `False` in combination with `show_everything=True` if you want to see data from Fallen and Awakened Empires 
-  - `extract_system_ownership`: Set to `False` if you do not want to extract ownership data for the interactive galaxy map, as it is somewhat resource-intensive.
+  - `extract_system_ownership`: Set to `False` if you do not want to extract ownership data for the interactive galaxy map, as it may be somewhat resource-intensive.
 
 Note: Only the `config.ini` file that is in the same directory as the `config.py` will be used. If you installed the program using `pip install .` without the `-e` flag, then this will probably be somewhere else in a `..../site-packages/stellarisdashboard` folder or similar.
 
@@ -127,12 +126,12 @@ The Hardware requirements depend on several factors:
 ## CPU
 If the dashboard cannot keep up, it may miss some data or certain events in the event ledger may be recorded incorrectly.
 
-If you have a quad-core CPU or better, I suggest 2 threads. By default, the dashboard uses about half of the available threads.
+If you have a quad-core CPU or better, I suggest allowing 2 threads. By default, the dashboard uses one less than half of the available threads.
 
 If the dashboard cannot keep up, you can also reduce the Autosave frequency in the Stellaris options menu.
 
 ## Disk Space
-The database should only require a few megabytes of space. Each game's data is stored in a separate database in your output folder, so you can delete them individually if you wish. 
+The database itself should only require a few megabytes. Each game's data is stored in a separate database in your output folder, so you can delete them individually if you wish.
 
 The game continuously deletes the oldest autosave so only the most recent files are kept. If you plan a long game 
 and want to be able to re-generate the database later, you need to continually backup the save files yourself.
@@ -142,10 +141,10 @@ This uses much more disk space for all the save files, but allows you to rebuild
 
 # Known Issues
 
-  1. Food budget numbers do not always match up (but should be reasonably close)
-  2. Other budget items should be more correct, but I definitely do not take all modifiers into account. (Again, values should be close enough under most circumstances)
-  3. Systems that are added to the map mid-game (e.g. precursor homeworlds) are currently not added to the database.
-  4. Reloading old save files may or may not mess up the data base
+  1. Budget numbers (especially for food) do not always match up (but should be reasonably close)
+  2. Systems that are added to the map mid-game (e.g. precursor homeworlds) are currently not added to the database.
+  3. Reloading old save files may or may not mess up the data base.
+  4. Renaming leaders, planets and system might not be reflected in the database and might lead to duplicate or missing entries or other issues.
 
 ## Contributions