Skip to content

Commit 108ca55

Browse files
committed
[DOCS] Usage
1 parent fb57d89 commit 108ca55

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

EDSSharp/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,4 @@ It is a work in progress and is rapidly changing.
2121

2222
Every attempt has been made to comply with the relevant DSP306 and other standards and EDS files from multiple sources have been tested for loading/saving and as been (at times) validated for errors using EDS conformance tools.
2323

24-
Usage
25-
-----
26-
- Using `dotnet run`, your {name} is `dotnet run EDSSharp/Program.cs --project EDSSharp --framework [net481/net8.0]`.
27-
- Using compiled version, your {name} is the name of your executable.
28-
- Depending on your environment, you may or may not need to use ./ at the beginning of your command
29-
30-
`{name} --infile FILE1 --outfile FILE2 [--type EXPORTER]`<br>
31-
Converts a given XDD or EDS file to many other available types.<br>
32-
Example: {name} --infile project.xdd --outfile map.md --type NetworkPDOReport<br>
33-
<br>
34-
FILE1 shall be a .xdd or .eds file.<br>
35-
FILE2 shall have the extension of one of the supported exporters below.<br>
36-
EXPORTER shall be one of the listed exporters below IF AND ONLY IF multiple of them support your output file extension.<br>
37-
<br>
3824
[Available exporters' list can be found here](https://github.com/CANopenNode/CANopenEditor?tab=readme-ov-file#available-formats).

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,16 @@ This repository is home to three projects:
1919
- [A CLI](https://github.com/CANopenNode/CANopenEditor/blob/docs/EDSSharp/README.md), used for simple conversions across all supported formats.
2020
- [A GUI](https://github.com/CANopenNode/CANopenEditor/blob/docs/EDSEditorGUI/README.md) for full manipulation of your CANopen files [which is being rewritten to be more multi platform](https://github.com/CANopenNode/CANopenEditor/blob/docs/EDSEditorGUI2/README.md).
2121

22+
How to use
23+
--------
24+
1. [Download the latest release's binary zip file](https://github.com/CANopenNode/CANopenEditor/releases). DO NOT DOWNLOAD SOURCE CODE.
25+
2. Unzip it.
26+
3. Go to net8.0-windows directory.
27+
4. Execute the .exe .
28+
2229
Available formats
2330
--------
24-
Exhaustive list of the library's supported formats sorted by category:<br>
31+
Exhaustive list of the library's supported formats to date, sorted by category:<br>
2532

2633
### CAN in Automation official formats:
2734
| Description | Exporter | Format |

0 commit comments

Comments
 (0)