StarOpenSource/CORE
StarOpenSource/CORE
2
0
Fork 0
Code Issues Pull requests Releases 1 Activity

Update file structure

Browse source
This commit is contained in:
JeremyStar™ 2024-05-18 16:38:56 +02:00
parent 12548963b4
commit e9b1169d98
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
1 changed files with 36 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

56
README.md
View file

@ -109,22 +109,16 @@ Here's a file structure for this project:
│   ├── build-distrib-assetlibrary.sh Builds a distribution directory for distributing CORE in the Godot Asset Library. │   ├── build-distrib-assetlibrary.sh Builds a distribution directory for distributing CORE in the Godot Asset Library.
│   ├── build-distrib-git.sh Builds a distribution directory for distributing CORE using git. │   ├── build-distrib-git.sh Builds a distribution directory for distributing CORE using git.
│   ├── core.png │   ├── core.png
│   ├── core.png.import
│   ├── core.xcf │   ├── core.xcf
│   ├── FiraCode │   ├── FiraCode
│   │   ├── Bold.ttf │   │   ├── Bold.ttf
│   │   ├── Bold.ttf.import
│   │   ├── Light.ttf │   │   ├── Light.ttf
│   │   ├── Light.ttf.import
│   │   ├── Medium.ttf │   │   ├── Medium.ttf
│   │   ├── Medium.ttf.import
│   │   ├── Regular.ttf │   │   ├── Regular.ttf
│   │   ├── Regular.ttf.import
│   │   ├── Retina.ttf │   │   ├── Retina.ttf
│   │   └── Retina.ttf.import
│   └── submodules Contains all submodules CORE uses │   └── submodules Contains all submodules CORE uses
│   └── besseretests │   └── besseretests
├── docs CORE's documentation, includes a Makefile ├── docs CORE's documentation
│   ├── babel.config.js │   ├── babel.config.js
│   ├── docs Where all documentation pages lie │   ├── docs Where all documentation pages lie
│   │   ├── about.md │   │   ├── about.md
@ -132,17 +126,28 @@ Here's a file structure for this project:
│   │   │   ├── _category_.json │   │   │   ├── _category_.json
│   │   │   ├── initializing-core.md │   │   │   ├── initializing-core.md
│   │   │   └── setting-up.mdx │   │   │   └── setting-up.mdx
│   │   ├── guides Various guides for specific stuff
│   │   │   ├── _category_.json
│   │   │   └── custom-modules.md
│   │   ├── reference CORE class and module reference │   │   ├── reference CORE class and module reference
│   │   │   ├── _category_.json │   │   │   ├── _category_.json
│   │   │   ├── coreconfiguration.md │   │   │   ├── classes Reference for classes
│   │   │   ├── core.md │   │   │   │   ├── basemodule.md
│   │   │   ├── coretypes.md │   │   │   │   ├── _category_.json
│   │   │   │   ├── core.md
│   │   │   │   ├── loggerinstance.md
│   │   │   │   ├── types.md
│   │   │   │   ├── validationschema.md
│   │   │   │   └── validationsingle.md
│   │   │   └── modules Reference for modules
│   │   │   ├── _category_.json
│   │   │   ├── config.md
│   │   │   ├── erm.md │   │   │   ├── erm.md
│   │   │   ├── loggerinstance.md
│   │   │   ├── logger.md │   │   │   ├── logger.md
│   │   │   ├── misc.md │   │   │   ├── misc.md
│   │   │   ├── sms.md │   │   │   ├── sms.md
│   │   │   └── storage.md │   │   │   ├── storage.md
│   │   │   └── validation.md
│   │   └── terminology.md │   │   └── terminology.md
│   ├── docusaurus.config.ts Documentation configuration │   ├── docusaurus.config.ts Documentation configuration
│   ├── Makefile Makefile for managing the documentation │   ├── Makefile Makefile for managing the documentation
@ -153,9 +158,6 @@ Here's a file structure for this project:
│   ├── src │   ├── src
│   │   ├── css │   │   ├── css
│   │   │   └── custom.css │   │   │   └── custom.css
│   │   └── pages
│   │   ├── index.module.css
│   │   └── index.tsx
│   ├── static │   ├── static
│   │   └── dist │   │   └── dist
│   │   └── core.png -> ../../../dist/core.png Symlink to the framework icon │   │   └── core.png -> ../../../dist/core.png Symlink to the framework icon
@ -163,29 +165,35 @@ Here's a file structure for this project:
├── LICENSE ├── LICENSE
├── project.godot ├── project.godot
├── README.md ├── README.md
├── src Contains the source code ├── src Contains the framework source code
│   ├── classes │   ├── classes Contains all classes except for 'Core'
│   │   ├── basemodule.gd │   │   ├── basemodule.gd
│   │   ├── config.gd │   │   ├── config.gd
│   │   ├── loggerinstance.gd │   │   ├── loggerinstance.gd
│   │   └── types.gd │   │   ├── types.gd
│   │   ├── validationschema.gd
│   │   └── validationsingle.gd
│   ├── core.gd │   ├── core.gd
│   ├── erm.gd │   ├── erm.gd
│   ├── logger.gd │   ├── logger.gd
│   ├── logui.gd │   ├── logui.gd
│   ├── misc.gd │   ├── misc.gd
│   ├── sms.gd │   ├── sms.gd
│   └── storage.gd │   ├── storage.gd
├── Test.gd Test script, only for testing during development │   └── validation.gd
├── Test.gd Dev script, only for testing during development
├── tests For unit testing ├── tests For unit testing
│ ├── test_resources Scripts, scenes and other resources used in tests │ ├── test_resources Scripts, scenes and other resources used in tests
│ │   ├── custom_module.gd A custom module used in 'tests/unit/core.gd' │ │   ├── custom_module.gd A custom module used in 'tests/unit/core.gd'
│ │   ├── scene.gd Updates the callback value │ │   ├── scene.gd Updates the callback value
│ │   └── scene.tscn Loads 'scene.gd' │ │   └── scene.tscn Loads 'scene.gd'
│ ├── unit The actual unit tests │ ├── unit The actual unit tests
│ │   ├── core.gd │   │   ├── core.gd
│ │   ├── misc.gd │   │   ├── erm.gd
│ │   └── sms.gd │   │   ├── misc.gd
│   │   ├── sms.gd
│   │   ├── storage.gd
│   │   └── validation.gd
│   └── unitbase.gd The base for all of our unit tests, includes functions and variables used in all unit tests. │   └── unitbase.gd The base for all of our unit tests, includes functions and variables used in all unit tests.
└── Test.tscn Simply executes `Test.gd` └── Test.tscn Stub class, has script 'Test.gd' attached
``` ```