Skip to content

Latest commit

 

History

History
52 lines (40 loc) · 1.51 KB

index-documenting.asciidoc

File metadata and controls

52 lines (40 loc) · 1.51 KB

Back to the main Documents index

GOAL: The Best Documented Project Ever

We aim to make this project the best documented project ever…​

At this point in time the documentation is a big work in progress and will probably change a good deal in layout and structure. Improving as we go. So please update your copy frequently.

Why documentation?

Because that will help speed up the development of Machinekit…​

If the documentation of this project can help a Person get started, a User get better, an Integrator working faster and help a Developer maintaining focus and better reference then everybody can benefit from this wonderfull project.

What is Machinekit?

Machinekit is a fast evolving project. The development of recent years have resulted in smaller and faster processors, different OS’es and a lot of applications that were not possible before. Think about the reprap project for example.

This fast evolving time asks for:

  • Up-to-date instructions.

  • Up-to-date examples.

  • Up-to-date references.

  • Up-to-date knowledge.

How can i help documenting?

  1. read up on contributing.

  2. get a Github user account.

  3. fork the machinekit-docs repo.

  4. read these instructions.

Back to the main Documents index