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.

Sign up for GitHub

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

Jump to bottom

Update documentation #7

Open
melipass opened this issue Aug 28, 2021 · 1 comment
Open

Update documentation #7

melipass opened this issue Aug 28, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@melipass
Copy link
Owner

We should be using Docsify to document the project.
@melipass melipass added the documentation Improvements or additions to documentation label Aug 28, 2021
@melipass
Copy link
Owner Author

melipass commented Nov 6, 2021

The repository should be renamed and a new name must be given to the project. An overhaul to the README.md file must be done this semester, and there should be a Docsify page (this is still up to discussion though) explaining:

  • How to run the files.
  • How to resize the spin matrix in every dimension.
  • How to apply the default magnetic states such as ferromagnetism, paramagnetism, etc.
  • How to rotate the spin arrows.
  • How to animate and use the config.json file.
  • How to use our automata.

Rendering shall not be documented, as this project has nothing worth mentioning that hasn't been said before in any Blender rendering tutorial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@melipass