Skip to content

Commit e494b71

Browse files
Update README.md
1 parent db86399 commit e494b71

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
11
# ILR_File_Creator
22

33
## Overview:
4-
The DFE tool for creating XML files that can be uploaded to their website is slow and limited in its function. My organization an Airtable that contains all the information it asks for but its hard to move all that information into the DFE tool. To fix this we built a new ILR tool that takes the CSV values generated from our Airtable and processes them to a XML file automatically. If you want to create a similar Airtable or Excell document that can be fed into this tool a guide is at the bottom fo this document.
4+
The DFE tool for creating XML files that can be uploaded to their website is slow and limited in its function. My organization an Airtable that contains all the information it asks for but its hard to move all that information into the DFE tool. To fix this we built a new ILR tool that takes the CSV values generated from our Airtable and processes them to a XML file automatically. If you want to create a similar Airtable or Excell document that can be fed into this tool a CSV for creating one is at the bottom of the readme. This project is an electron application and following the set up instruction will create an app for whatever operating system you build it on. If you want to make aplications for other operating systems more information about distributing electron apps with electron forge can be found [here]([url](https://www.electronforge.io/)).
55

66
## User Stories
77

88
* User can upload a cvs file to application
99
* App will tell user if there are any empty or missing fields in the CSV list
1010
* App will return a XML file to the user thats structure matches that required by the DFE
1111

12+
* ## Libraires Used
13+
14+
* electron
15+
16+
* electron forge
17+
18+
* xmllint
19+
20+
* papaparse
21+
22+
1223

1324
## Usage
1425
This repo can be used to update and create copies of the ILR tool app. Bellow I will give general instructions for making creating copies of the app and how to update the tool when the ILR produces new versions. (note I can not account for everything they might change in a version and future users may need to update the code to account for changes made in a new academic year) Finally I will provide instructions for how to use the app and organize your table.

0 commit comments

Comments
 (0)