Skip to content

Commit c3aa7c0

Browse files
authored
Create README.md
1 parent 7d82450 commit c3aa7c0

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Json Maker Console App
2+
3+
You may be wondering what this does and thats pretty complex to answer. But I will start off by providing some background. This project was made for a science fair, and the inspiration was from JSON Loader from the Inscryption Modding scene and the Json Editor site.
4+
5+
### What this App can do
6+
7+
* SCHEMA
8+
- Make a Schema from scratch no its not automated its user input based.
9+
- Save a Schema, you must create it first.
10+
* JSON
11+
- Make a JSON from any provided schemas with validation and syntax.
12+
- Save JSONs based on the JSON you create
13+
14+
### What can be configured:
15+
16+
- Colorful Text - Basically if text should be printed with color.
17+
- Property Descriptions - Toggle whether descriptions are shown on properties in json making.
18+
- Property Syntax - Toggle whether property syntax is shown in json making.
19+
- Show the Field Type with Name - Toggle whether the property type is shown by the name in json making.
20+
- JSON Extension Type - Change the exported extension type [Let me know if this is not working]
21+
- Save File Path - You can change where files are saved to on both the json and schema iirc its still tied to the directory's folder so to go out you'll have to add some `../` to the definition.
22+
- Save with Custom Names - Toggle whether JSONS or SCHEMAS will be saved with custom names.
23+
- Case Correction - Toggle whether Case Correction will occur on saving.
24+
25+
### How to setup by default:
26+
27+
1. Install the latest release.
28+
2. Unzip the zip to a folder of your liking.
29+
3. Run the application and configure it.
30+
4. Select JSON or Schema and select `make` after select `save`.
31+
32+
### How to add Schemas to your application
33+
34+
1. Navigate to `files/schemas`
35+
2. Get all your schemas
36+
3. Make sure they end with the `JSON Extenstion Type`'s value
37+
4. Run The Application
38+
5. Test it by making a JSON
39+
40+
### How you can Contribute:
41+
42+
* Sharing
43+
* Contributing via PR's
44+
* Showcasing
45+
* Spreading the word
46+
* Testing it out
47+
* Providing Feedback

0 commit comments

Comments
 (0)