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

Create a final documentation for the project #52

Open
Courtsilius opened this issue May 7, 2024 · 2 comments
Open

Create a final documentation for the project #52

Courtsilius opened this issue May 7, 2024 · 2 comments
Assignees
Milestone

Comments

@Courtsilius
Copy link
Collaborator

TODO

@nhergen nhergen added this to the Sprint 4 milestone Jun 26, 2024
@FabiKogWi FabiKogWi self-assigned this Jul 1, 2024
@C3YLA C3YLA modified the milestones: Sprint 4, Sprint 5 Jul 10, 2024
@saraerciyess
Copy link
Collaborator

I created a design for the presentation.
->See Figma

@saraerciyess saraerciyess self-assigned this Aug 21, 2024
@FabiKogWi
Copy link
Collaborator

For the ReadMe (our external documentation) I will use the following structure:

  • Overview: Short description of our project
  • Install instructions: Detailing how to install the project and which dependencies you need to use
  • Overview of written code: Documentation on the code written to support our project and how to use it if one wants to build their own version of it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants