1
0
mirror of https://github.com/MarlinFirmware/Marlin.git synced 2024-11-29 23:07:42 +00:00

Updated Home (markdown)

Scott Lahteine 2017-12-05 00:22:02 -06:00
parent 51321fc6c9
commit 3d03780151

63
Home.md

@ -1,50 +1,31 @@
# Marlin Firmware # # Marlin Firmware
## About this Wiki ## ## About this Wiki
This wiki describes official Release versions of Marlin, currently [Version 1.0.2-1](https://github.com/MarlinFirmware/Marlin/releases/tag/1.0.2-1) and the upcoming [Version 1.1.0](https://github.com/MarlinFirmware/Marlin/releases). Most of the documentation here is still under development. Please pitch in if you see any topic that needs improvement. This wiki is now obsolete! For current Marlin documentation please visit the official [Marlin Website](http://marlinfw.org/). There you will find several essential guides:
## Current Development ## ### Overview
For information related to **cutting-edge development and testing on Version 1.2 and beyond**, head over to the [Marlin Development Wiki](https://github.com/MarlinFirmware/MarlinDev/wiki). There you can find guidance on the new file layout, obtaining the hardware support package, and how to integrate Marlin with Arduino >= 1.6.7.
For information related to **patching current releases and release candidates (beta releases)** see [[Reporting Bugs]] and [[Contributing]] here in this wiki. - [Introduction](http://marlinfw.org/docs/basics/introduction.html) - What is Marlin all about?
- [Marlin G-code](http://marlinfw.org/meta/gcode/) - Guide to the G-code control language used by Marlin.
- [Auto Bed Leveling](http://marlinfw.org/docs/features/auto_bed_leveling.html) - Compensating for bed imperfections.
- [Firmware Retract](http://marlinfw.org/docs/features/fwretract.html) - Allowing the firmware to handle retraction.
- [Linear Advance](http://marlinfw.org/docs/features/lin_advance.html) - Pressure-based extrusion eliminates ooze and produces sharper corners.
- [Unified Bed Leveling](http://marlinfw.org/docs/features/unified_bed_leveling.html) - Next-generation leveling system with extra options.
## Introduction ## ### Installation and Configuration
Marlin is a highly optimized firmware for 3D printers based on AVR-based microprocessors (such as those used on the [Arduino](http://arduino.cc) platform) with movement driven by stepper motors.
Through the use of a programmer tool, Marlin is flashed directly onto the PROM on your 3D printer's controller board, and will thereafter run standalone. Marlin controls the input/output, voltage states, and movement of the 3D printer, taking buffered command streams from SD cards and host controllers. - [Downloading Marlin](http://marlinfw.org/meta/download/) - List of available downloads.
- [Installing Marlin](http://marlinfw.org/docs/basics/install.html) - A very basic installation overview.
- [Configuring Marlin](http://marlinfw.org/docs/configuration/configuration.html) - Configuration options in detail.
Marlin aims to be adaptable to as many boards and as many configurations as possible, with a very lean default profile. Depending on configuration options, the size of the Marlin binary image may be as low as 50K or over 200K. ### Contributing to Marlin
A huge number of features are included, such as: - [Getting Started with Pull Requests](http://marlinfw.org/docs/development/getting_started_pull_requests.html) - How to contribute code to Marlin through Github.
- [Coding Standards](http://marlinfw.org/docs/development/coding_standards.html) - Describes indentation, naming conventions, and other details about contributed code.
* A rich dialect of [[G-Code in Marlin|G-Code]] ## Essential Marlin Resources
* USB communication with messages for hosts
* A growing list of [[Supported Hardware|specific boards]]. Over 40 now supported.
* More than 20 languages supported, including Japanese and Russian
* Support for [[LCD Controllers]] and [[SD cards]]
* In addition to [[Cartesian_Kinematics|Cartesian]] kinematics Marlin also supports [[Delta_Kinematics|Delta]], [[SCARA_Kinematics|SCARA]], [[CoreXY]], and [[CoreXZ]]
* Support for up to 4 extruders
* Support for [[Thermistors]] and [[thermocouples]]
* [[Thermal Runaway Protection]]
* [[EEPROM]] save and restore
* Support using switches or sensors as proximity probes
* Probes on servo arms
* Probes that can be picked up and dropped
* Probes that can be enabled/disabled
* Bed Tilt Compensation, for better results printing on a non-level bed
* [[Mesh Bed Leveling]], with save to EEPROM
* [[Manual Bed Leveling]], step-by-step using an LCD controller
* [[Bed Auto Leveling]], which requires some kind of Z Probe
* [[Firmware Retraction]], to allow retraction tuning without re-slicing
* [[Acceleration]] and [[Jerk]] tuning, for better corners and surface finish
* Support for [[Dual X Carriage]] setups
* Support for [[Filament Runout Sensor]] and [[Filament Width Sensor]]
* ...and much more!
## Essential Resources ## * [Marlin on Github](https://github.com/MarlinFirmware/Marlin) The home of Marlin Development.
* [Marlin Releases](https://github.com/MarlinFirmware/Marlin/release) - Listing stable releases with change-log and known issues.
* [Marlin Development Repository on Github](https://github.com/MarlinFirmware/MarlinDev) Marlin Development Central. Help design, develop, document, test, and improve Marlin 1.2 and beyond. _Arduino 1.6.7 has sub-folders, and the future is looking bright!_ * [Marlin 1.1 "Bugfix"](https://github.com/MarlinFirmware/Marlin/tree/bugfix-1.1.x) - Current pre-release beta in development and testing.
* [Marlin Release Repository on Github](https://github.com/MarlinFirmware/Marlin) * [Marlin 2.0 "Bugfix"](https://github.com/MarlinFirmware/Marlin/tree/bugfix-2.0.x) - Next-generation Marlin with 32-bit support.
* [Marlin Current Releases](https://github.com/MarlinFirmware/Marlin/releases) including pre-release versions
* [Marlin Release Candidate](https://github.com/MarlinFirmware/Marlin/tree/RC) Current pre-release beta in testing
* [The RC Bug Patch](https://github.com/MarlinFirmware/Marlin/tree/RCBugFix) is where all patches to RC are collected ahead of the next release candidate