EliteBGS.csproj

@@ -185,8 +185,15 @@
     <None Include="App.config" />
   </ItemGroup>
   <ItemGroup>
-    <Resource Include="main-page.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    <Content Include="docs\main-objectives.png" />
+    <Resource Include="main-entries.png">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Resource>
+    <Resource Include="main-objectives.png">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Resource>
+    <Resource Include="main-report.png">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Resource>
     <None Include="README.md">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
@@ -206,9 +213,10 @@
     </None>
   </ItemGroup>
   <ItemGroup>
-    <Resource Include="docs\main-page.png">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </Resource>
+    <Content Include="docs\main-entries.png" />
+  </ItemGroup>
+  <ItemGroup>
+    <Content Include="docs\main-report.png" />
   </ItemGroup>
   <ItemGroup>
     <Content Include="LICENCE.txt">

README.md

@@ -11,8 +11,17 @@ Binary downloads can be found here: [https://bgs.n0la.org/](https://bgs.n0la.org
 
 ## How To
 
-Press "Parse Journal", which will check your Elite Dangerous player journal for completed
-transactions. Currently the tool recognises the following transactions:
+![Main Window Objectives](main-objectives.png)
+
+Use the main tab to add objectives to the program. To do this, insert the system name,
+faction, and, optionally, a station. Then press "Add Objective". Objectives can be deleted
+by selecting them and pressing the "DEL" key. Manually added objectives like this are
+enabled by default. You can always enable, and disable an objective by checking the box
+next to its name. Disabled objectives are not included in the BGS discord log generation.
+
+Once you have your objectives have been configured, you can press "Parse Journal", which
+will check your Elite Dangerous player journal for completed missions. Currently the tool
+recognises the following completed tasks:
 
 * Buying of cargo from stations (new in Update 10)
 * Completed missions
@@ -63,7 +72,7 @@ you the bounty. And not the faction of the victim. The tool will look for an eve
 scanned your victim, and gleem the victim's faction from that. If you did not scan your victim, then
 sadly the tool cannot connect the victim's faction to the victim.
 
-![Main Window with entries](main-page.png)
+![Main Window with entries](main-entries.png)
 
 The window will then list all the journal entries it has found, and group them by objectives. You
 can select which objectives you wish to report, by using the checkmarks.
@@ -73,10 +82,13 @@ This way said entry will not appear in the final log. You can also remove indivi
 (if you think the tool detected something you thought was wrong), by selecting the entry,
 and pressing the "DEL" key. 
 
-Once you are satisfied with the result, the discord report should be displayed below, ready to be
-copy and pasted. Before you copy/paste it into the discord of your squadron, you should check the log.
-You can of course edit it, if something is wrong or the tool itself missed something. If you want to
-regenerate it, just click "Generate Log".
+Once you are satisfied with the result, move to "Discord Report" tab, select a template, and click
+"Generate Report".
+
+![Generated Report](main-report.png)
+
+Before you copy/paste it into the discord of your squadron, you should check the log. You can of
+course edit it, if something is wrong or the tool itself missed something.
 
 ## Known Issues and Bugs
 

docs/CHANGELOG.md

@@ -1,12 +1,5 @@
 # EliteBGS changelog
 
-## 0.1.7 on 09.11.2022
-
-* Fixed a bug related to total amount of credits gained by turning in organic data.
-* Changed UI to have report, and objectives on the same page.
-* Report now automatically updates when objectives and entries are selected, deselected or removed.
-* Removed manual adding of objectives.
-
 ## 0.1.6 on 24.09.2022
 
 * Fixed datetime format.

docs/description.md

@@ -11,8 +11,17 @@ Binary downloads can be found here: [https://bgs.n0la.org/](https://bgs.n0la.org
 
 ## How To
 
-Press "Parse Journal", which will check your Elite Dangerous player journal for completed
-missions. Currently the tool recognises the following completed tasks:
+![Main Window Objectives](main-objectives.png)
+
+Use the main tab to add objectives to the program. To do this, insert the system name,
+faction, and, optionally, a station. Then press "Add Objective". Objectives can be deleted
+by selecting them and pressing the "DEL" key. Manually added objectives like this are
+enabled by default. You can always enable, and disable an objective by checking the box
+next to its name. Disabled objectives are not included in the BGS discord log generation.
+
+Once you have your objectives have been configured, you can press "Parse Journal", which
+will check your Elite Dangerous player journal for completed missions. Currently the tool
+recognises the following completed tasks:
 
 * Buying of cargo from stations (new in Update 10)
 * Completed missions
@@ -63,7 +72,7 @@ you the bounty. And not the faction of the victim. The tool will look for an eve
 scanned your victim, and gleem the victim's faction from that. If you did not scan your victim, then
 sadly the tool cannot connect the victim's faction to the victim.
 
-![Main Window with entries](main-page.png)
+![Main Window with entries](main-entries.png)
 
 The window will then list all the journal entries it has found, and group them by objectives. You
 can select which objectives you wish to report, by using the checkmarks.
@@ -73,12 +82,13 @@ This way said entry will not appear in the final log. You can also remove indivi
 (if you think the tool detected something you thought was wrong), by selecting the entry,
 and pressing the "DEL" key. 
 
-Once you are satisfied with the result, you can copy and paste the final report to the discord
-server of your choice. Before you copy/paste it into the discord of your squadron, you should
-check the log. You can of course also edit it, either if something is wrong because the tool
-missed something, or you just wish to add a note the report itself.
+Once you are satisfied with the result, move to "Discord Report" tab, select a template, and click
+"Generate Report".
 
-If you wish to regenerate the discord log, simply click "Generate Log".
+![Generated Report](main-report.png)
+
+Before you copy/paste it into the discord of your squadron, you should check the log. You can of
+course edit it, if something is wrong or the tool itself missed something.
 
 ## Known Issues and Bugs
 

docs/index.md

@@ -53,9 +53,9 @@ It requires a separate library, called EDJournal, which is also open source:
 
 ## Downloads
 
-The latest version of EliteBGS **0.1.7** is available for download here:
+The latest version of EliteBGS **0.1.6** is available for download here:
 
-* [https://bgs.n0la.org/elitebgs-0.1.7.zip](https://bgs.n0la.org/elitebgs-0.1.7.zip)
+* [https://bgs.n0la.org/elitebgs-0.1.6.zip](https://bgs.n0la.org/elitebgs-0.1.6.zip)
 
 Older versions are available in the archive: