Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[rewrite/v3]Crate layout #46

Merged
merged 4 commits into from
Sep 16, 2024

Conversation

Asurar0
Copy link
Contributor

@Asurar0 Asurar0 commented Sep 16, 2024

A lot of the structure have changed and some preliminary usage informatioins can be found at src/README.MD.

Code source layout

FerrumC define the following primary crates inside its source code:

  • ferrumc-core
  • ferrumc-ecs
  • ferrumc-events
  • ferrumc-net
  • ferrumc-storage
  • ferrumc-utils
  • ferrumc-world
  • ferrumc-plugins

Each crate may contain subcrates within its directory to implement essential components. For example:

- core/          # ferrumc-core
- net/           # ferrumc-net
    - encode     # ferrumc-net-encode

Dependencies

Dependencies are defined in the workspace Cargo.toml file and imported into each crate using the following syntax:

crate = { workspace = true }

Workspace members dependencies are defined as follows:

member = { workspace = true } 

Tests

Tests are located within their respective crates and do not have a separate tests/ folder.

@Asurar0 Asurar0 changed the title Crate layout [rewrite/v3]Crate layout Sep 16, 2024
@ReCore-sys ReCore-sys merged commit 70b834f into ferrumc-rs:rewrite/v3 Sep 16, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants