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

Repository clean-up #1

Closed
Siccity opened this issue Jul 3, 2019 · 1 comment
Closed

Repository clean-up #1

Siccity opened this issue Jul 3, 2019 · 1 comment
Assignees

Comments

@Siccity
Copy link

Siccity commented Jul 3, 2019

Hello!

I watched your video on youtube and checked out your plugin. It works really well! However i have one big gripe with it - the project it very messy. Here's my proposal:

  1. Move all assets from Marching-Cubes-Improved up into the root, and delete the rest (Logs, ProjectSettings, .vscode). Your project files aren't needed.
  2. Delete Rider plugin as it has nothing to do with the marching cubes implementation.
  3. Make an Examples folder and move all files that aren't an absolute neccessary part of core functionality into that folder (SampleScene, FreeCam.cs, TerrainEditor.cs, FastNoise.cs, DensityGenerator.cs etc.)
  4. Use namespaces. Especially important when you're using class names such as "World" and "Utils".
  5. If "World" is part of the core, don't let it refer to anything in the examples folder. The Examples folder should be optional and deleteable. If you need something to generate a world on awake in the sample scene, do it in a separate script. This also helps to showcase how a user would do it.
  6. Is the Prefabs/Chunk used at all? If not, remove it.

Doing like this will help users navigate your project much easier, as well as enabling the ability to clone your repo directly into their project so they can start using it.

@Eldemarkki
Copy link
Owner

Hey! Thanks for this suggestion! I agree it is quite messy, and should definitely be cleaned up. I'm a little busy this week but I will get started on this as soon as possible.

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

No branches or pull requests

2 participants