Skip to content

Commit 831ea5f

Browse files
authored
Added a readme file
1 parent 80caed9 commit 831ea5f

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

readme.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# GTN Module Editor
2+
Application for editing AppXpress module exports from the GT-Nexus platform
3+
4+
## How to use
5+
6+
1. Download and run the program
7+
2. Import a module by entering `import [path-to-zip-file]`
8+
3. Select a working item path
9+
- In module root (command line starts with `/[module-name-here]>`)
10+
- Use `ls` to list design roots
11+
- Use `cd [design-type]` to select a design root
12+
- Use `cd [design-type]/[field-name]` to select a field root
13+
- In design root (line starts with `/[module-name-here]/[design-type-here]>`)
14+
- Use `ls` to list fields
15+
- Use `cd [field-name]` to go to a field root
16+
- Use `cd ..` to go back to the module root
17+
- In field root (line starts with `/[module-name-here]/[design-type-here]/[field-name-here]>`)
18+
- Use `cd ..` to go back to the design root
19+
- Use `cd ../..` to go back to the module root
20+
4. Edit module, design, or field properties
21+
- Use `listp` to list the properties on the working item
22+
- Use `getp [key]` to get the current value of a property
23+
- Use `setp [key] [value]` to set the value of a property
24+
5. Export your new module using `export [path-to-store-zip]`
25+
26+
## How to build
27+
28+
You will need to install the .NET Core using the instructions [here](https://www.microsoft.com/net/learn/get-started) to build this application.
29+
Once you've edited the files you want to change, open the repository folder in a terminal and enter `dotnet run`. The .NET Core will build and launch the application automatically.

0 commit comments

Comments
 (0)