klipper/docs
lf a33792f07e util: Fix versioning when gitdir is absent (#809)
The gitdir previously could be absent and produce a version of "" in
spite of checks for it. Fixed.

Parent directories with shlex-interpreted characters in their names
could be misinterpreted. Removed shlex parsing.

Packagers may want to remove the git history to slim down the package
size, so add an option for using a file 'version' in the klippy
directory to set version without using git.

Signed-Off-By: Lucas Fink <software@lfcode.ca>
2018-10-27 10:44:38 -04:00
..
img docs: Add Delta_Calibrate.md guide with "enhanced delta calibration" 2018-09-25 13:48:46 -04:00
prints delta_calibrate: Initial support for enhanced delta calibration 2018-09-25 13:48:46 -04:00
Bootloaders.md docs: Updates to stm32f103 benchmarks 2018-10-11 10:57:24 -04:00
CONTRIBUTING.md docs: Add a CONTRIBUTING document 2017-12-24 12:33:01 -05:00
Code_Overview.md docs: Add a section with micro-controller porting tips to Code_Overview.md 2018-07-11 14:40:39 -04:00
Config_checks.md docs: Add an Endstop_Phase.md document 2018-10-16 13:09:49 -04:00
Contact.md docs: Expand on why it is important to provide the log in Contact.md 2018-07-08 20:30:35 -04:00
Debugging.md docs: Fix SAM4E8E benchmark test revision 2018-10-22 11:21:43 -04:00
Delta_Calibrate.md delta_calibrate: Do not automatically run G28 on DELTA_CALIBRATE 2018-10-22 11:26:01 -04:00
Endstop_Phase.md tmc2660: Add endstop phase detection functionality to TMC2660 extra (#816) 2018-10-24 16:01:12 -04:00
FAQ.md docs: Add a "Lost communication with MCU" section to the FAQ 2018-10-09 11:22:28 -04:00
Features.md docs: Update SAM4E8E benchmarks 2018-10-22 11:18:55 -04:00
G-Codes.md bed_mesh: Do not automatically run G28 on BED_MESH_CALIBRATE / BED_MESH_MAP 2018-10-22 11:26:01 -04:00
Installation.md gcode: Send proactive state messages 2018-09-12 21:31:27 -04:00
Kinematics.md docs: Minor change to wording of junction speeds 2018-08-03 15:48:07 -04:00
MCU_Commands.md basecmd: Rename get_status to get_clock 2018-05-29 10:57:29 -04:00
Overview.md docs: Add an Endstop_Phase.md document 2018-10-16 13:09:49 -04:00
Packaging.md util: Fix versioning when gitdir is absent (#809) 2018-10-27 10:44:38 -04:00
Pressure_Advance.md docs: Update pressure advance doc to note it only impacts the extruder 2018-10-25 19:09:47 -04:00
Protocol.md docs: Replace get_status example with get_clock in Protocol.md 2018-10-20 11:53:32 -04:00
README.md docs: Improve documentation for those starting in docs/ 2017-04-27 16:05:26 -04:00
Releases.md docs: Update release notes for v0.6.0 release 2018-03-31 14:04:39 -04:00
beaglebone.md pru: Disable ADC reading directly from the PRU 2018-06-27 12:10:25 -04:00
developer-certificate-of-origin docs: Add a CONTRIBUTING document 2017-12-24 12:33:01 -05:00
issue_template.md docs: Add github issue template 2018-01-31 14:30:05 -05:00
stm32f1.md docs: Update stm32f1.md - usb is now supported. 2018-10-22 13:22:58 -04:00

README.md

Welcome to the Klipper documentation. The overview document is a good starting point.