Difference between revisions of "Engine documentation"

From Minetest Developer Wiki
Jump to navigation Jump to search
m
Line 10: Line 10:
  
 
Head over to #minetest-doc on [[IRC]], and ask someone there to help you get started with documentation. You'll need to download the project through [[Git]] and then make your changes.
 
Head over to #minetest-doc on [[IRC]], and ask someone there to help you get started with documentation. You'll need to download the project through [[Git]] and then make your changes.
 +
[[Category:Core Engine]]

Revision as of 00:56, 16 February 2015

PLEASE NOTE: As of 2014, this page is grossly out of date. Ask on #minetest-dev.

Engine documentation is a way you can contribute to Minetest right now!

What we need

We want to document most or all of Minetest core with Doxygen-style code comments. The system for extracting information from those comments is not yet ready, but once we have comments in that format, it should be relatively simple to implement.

Where to start

Head over to #minetest-doc on IRC, and ask someone there to help you get started with documentation. You'll need to download the project through Git and then make your changes.