Skip to content

Commit 78a7970

Browse files
committed
Update docs
1 parent 8b17e6c commit 78a7970

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ Head over to the **Actions** tab, then download the artifacts for your OS from t
88

99
# Usage
1010
* Click **Open Background** from the **File** menu to select a background to draw the markers on.
11-
* Click **Add more markers** button and select Battle for Wesnoth *misc* directory (the one with the new_journey/new_rest marker etc.).
12-
* Select a marker from the adjoining list and click on the background to draw. Supported markers and their corresponding macros which will be generated can be [here](https://github.com/babaissarkar/WesnothMapTracker/blob/main/src/main/resources/names.properties). (You can map any other markers by editing the properties file and rebuilding, or can request me to add it.)
13-
* Save using **File > Save** once you are done. The output is like this:
11+
* Some markers are preloaded. Click **Load more graphics** button and select Battle for Wesnoth *misc* directory (the one with the new_journey/new_rest marker etc.) or your directory with more images to use them as markers.
12+
* Select a marker from the adjoining list and click on the background to draw. For preloaded markers, their corresponding macros which will be generated is defined [here](https://github.com/babaissarkar/WesnothMapTracker/blob/main/src/main/resources/names.properties). (You can map any other markers by editing the properties file and rebuilding, or can request me to add it.)
13+
* Save using **File > Save** once you are done (or copy/paste from the output text area in the bottom pane). The output is like this:
1414
```
1515
{NEW_JOURNEY 455 300}
1616
{NEW_REST 500 300}

src/main/resources/docs/Usage.html

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<ul>
2-
<li>Click <strong>Open Background</strong> from the <strong>File</strong> menu to select a background to draw the markers on.</li><br/>
3-
<li>Click <strong>Add more markers</strong> button and select Battle for Wesnoth <em>misc</em> directory (the one with the <em>new journey/new rest</em> markers etc).<br/>
4-
<strong>Supported Markers</strong><br/>
2+
<li>Click <strong>Open Background...</strong> from the <strong>File</strong> menu to select a background to draw the markers on.</li><br/>
3+
<li>The following markers are available by default:<br/>
54
<code>
65
new-journey.png=NEW_JOURNEY<br/>
76
dot-white.png=OLD_JOURNEY<br/>
@@ -12,7 +11,7 @@
1211
flag-red2.png=NEW_REST<br/>
1312
flag-white.png=OLD_REST<br/>
1413
</code>
15-
<br/>
14+
To add more, you can click the <strong>Load more graphics</strong> button and select the directory with the marker images.</li><br/>
1615
<li>Save using <strong>File > Save</strong> once you are done. The output is like this:
1716
<br/>
1817
<code>

0 commit comments

Comments
 (0)