Skip to content

Commit 30a86a9

Browse files
committed
add usage example images
1 parent 020528d commit 30a86a9

File tree

6 files changed

+31
-9
lines changed

6 files changed

+31
-9
lines changed

README.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ Removes parts from Kerbal Space Program crafts - and more :)
1515
* Checks all links to the removed part(s) and only removes parts with "hard" dependencies
1616
* Adapts "parent", "link", "sym", "SrfN" and "AttN" links on dependent parts
1717

18+
## General notes
19+
20+
* If no output file is specified, the input file is modified.
21+
* This tool supports a **--silent** switch and can be used programmatically should you desire.
22+
* It has been tested with the following types of files so far :
23+
* .craft files generated by KSP 1.12
24+
* .sfs files generated by KSP 1.12
25+
* .txt vessel files generated by LMPServer (not fully tested)
26+
1827
## Usage
1928
```
2029
KSPPartRemover v1.2
@@ -37,7 +46,7 @@ Commands:
3746
list-mods
3847
list mods used by the parts in the input file
3948
if you don't have a required mod installed it will be listed as UNKNOWN
40-
[KSPPartRemover needs to be in KSP directory for this to work!]
49+
[KSP directory needs to be your current directory for this to work!]
4150
4251
remove-parts
4352
remove one or more parts from one or more crafts
@@ -72,22 +81,35 @@ Switches:
7281
do not print additional info, do not ask for confirmation
7382
```
7483

75-
## General notes
84+
## Usage Examples
7685

77-
* If no output file is specified, the input file is modified.
78-
* This tool supports a **--silent** switch and can be used programmatically should you desire.
79-
* It has been tested with the following types of files so far :
80-
* .craft files generated by KSP 1.12
81-
* .sfs files generated by KSP 1.12
82-
* .txt vessel files generated by LMPServer (not fully tested)
86+
### list-crafts
87+
88+
![example-list-crafts](images/example-list-crafts.png)
89+
90+
### list-parts
91+
92+
![example-list-parts](images/example-list-parts.png)
93+
94+
### list-partdeps
95+
96+
![example-list-partdeps](images/example-list-partdeps.png)
97+
98+
### list-mods
99+
100+
![example-list-mods](images/example-list-mods.png)
101+
102+
### remove-parts
103+
104+
![example-remove-parts](images/example-remove-parts.png)
83105

84106
Release notes
85107
=======================
86108

87109
### KSPPartRemover v1.2
88110
* New command **list-mods**: list mods used by the parts in the input file
89-
* KSPPartRemover **needs** to be in KSP directory for this to work!
90111
* If you don't have a required mod installed it will be listed as **UNKNOWN**
112+
* **KSP directory needs to be your current directory** for this to work!
91113
* Make loading files much more tolerant (since part information from mods can now be loaded from KSP directory)
92114

93115
### KSPPartRemover v1.1

images/example-list-crafts.png

49.6 KB
Loading

images/example-list-mods.png

119 KB
Loading

images/example-list-partdeps.png

135 KB
Loading

images/example-list-parts.png

106 KB
Loading

images/example-remove-parts.png

124 KB
Loading

0 commit comments

Comments
 (0)