aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Installation.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Updates to Installation.md documentKevin O'Connor2022-05-171-44/+79
| | | | | | | Recommend users obtain an example config file prior to starting the installation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Rename DocumentsYifei Ding2021-11-221-1/+1
| | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* docs: Installation.md CapitalizationYifei Ding2021-11-221-2/+2
| | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* docs: Update documentation with new klipper github URLKevin O'Connor2021-09-231-1/+1
| | | | | | | | The main code repository moved from https://github.com/KevinOConnor/klipper.git to https://github.com/Klipper3d/klipper.git . Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-271-10/+7
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* docs: Use relative links for files outside the docs/ directoryKevin O'Connor2020-12-031-1/+1
| | | | | | | | Use javascript to fixup the "github pages" rendering of links to files outside the docs/ directory. Then use normal relative links in the documentation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move config reference information to new Config_Reference.mdKevin O'Connor2020-11-181-5/+3
| | | | | | | Move all the config reference information from files in the config/ directory to a new Config_Reference.md document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update OctoPrint and OctoPi versions in Installation.mdKevin O'Connor2020-09-041-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend RPi 2 or later in Installation.mdKevin O'Connor2020-02-171-2/+1
| | | | | | Reported by @patrickkettner. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend OctoPrint v1.3.12 in Installation.mdKevin O'Connor2019-10-301-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend OctoPrint 1.3.11 or laterKevin O'Connor2019-05-201-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid using .. in markdown linksKevin O'Connor2019-04-141-5/+5
| | | | | | | Using .. in the markdown link can confuse some document processors. Use an absolute link to github instead. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation.md to point to list of supported ARM mcusKevin O'Connor2019-04-061-3/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend OctoPi v0.16.0Kevin O'Connor2019-03-111-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation document to emphasize the "stay connected" stepKevin O'Connor2019-02-271-6/+8
| | | | | | | | Move the OctoPrint "stay connected" during error configuration step to its own paragraph. Hopefully this will make it less likely that users skip this step. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation document to suggest using /dev/serial/by-id/Kevin O'Connor2019-02-271-5/+38
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Kconfig: Move SERIAL_BAUD to src/Kconfig and show with LOW_LEVEL_OPTIONSKevin O'Connor2019-01-251-3/+1
| | | | | | | | Move the definition of SERIAL_BAUD to the main src/Kconfig file. Only show this as an option if the user selects the ability to configure low-level options. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Be more clear that a baud of 250000 is recommendedKevin O'Connor2018-11-131-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode: Send proactive state messagesKevin O'Connor2018-09-121-1/+1
| | | | | | Send a g-code info message on printer state changes. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update main documentation to not Smoothieboard supportKevin O'Connor2018-07-081-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update installation document for OctoPrint 1.3.7Kevin O'Connor2018-04-091-3/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update installation document with pointers to FAQKevin O'Connor2018-01-041-12/+16
| | | | | | Add some pointers to the FAQ for common pitfalls during installation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add an initial configuration checklist documentKevin O'Connor2017-12-261-0/+4
| | | | | | | Provide a document with basic steps that a user can run to verify that the pins in the configuration file are set correctly. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Offer alternatives to ssh/scp/sftpKevin O'Connor2017-12-211-31/+51
| | | | | | | | Try to make the Installation document more friendly to users not familiar with the Linux command-line. Offer some hints on how to obtain ssh and how to edit the config file remotely. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a FAQ documentKevin O'Connor2017-11-301-1/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation document to recommend latest octoprint versionKevin O'Connor2017-10-251-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Point to beaglebone.md from the main installation documentKevin O'Connor2017-10-111-5/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add Contact.md file with developer contact informationKevin O'Connor2017-10-101-0/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Make it clear a RESTART is likely needed in Installation documentKevin O'Connor2017-05-031-8/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend users stop klipper before flashing the micro-controllerKevin O'Connor2017-05-011-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve documentation for those starting in docs/Kevin O'Connor2017-04-271-2/+2
| | | | | | | | Those that reach Klipper via github may jump directly to the docs/ directory in search of documentation. Add README.md and rework Overview.md with that in mind. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Reword alternate linux machine in installation instructionsKevin O'Connor2017-04-241-4/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Installation updatesKevin O'Connor2017-04-241-55/+45
| | | | | | Recommend using 'make flash' and clean up the octoprint instructions. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* build: Add workaround to suppress broken avr-gcc "misspelled" warningsKevin O'Connor2017-04-241-3/+0
| | | | | | | Detect avr gcc v4.8.1 and then disable warnings during the klipper.o linking to suppress bogus "misspelled signal handler" warnings. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* scripts: Add octopi installation scriptsKevin O'Connor2017-04-211-36/+16
| | | | | | | | Add a system startup script so that Klipper can automatically start at boot time. Create an installation script that will install the system dependencies and the startup script. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode: Ignore M21 commandKevin O'Connor2017-04-201-3/+0
| | | | | | | No need to recommend users disable "SD card support" in octoprint - instead, just ignore the M21 command. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* hub-ctrl: Add support for micro-controller reset via RPi usb power togglingKevin O'Connor2017-04-131-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update installation documentKevin O'Connor2016-12-211-7/+26
| | | | | | | | | | Various installation updates. Recommend upgrade to OctoPrint v1.3.0. Recommend configuring OctoPrint to not disconnect on error. Note quirk with needing to reload page if "/tmp/printer" not in list of serial connections. Add brief documentation on use of extended commands and checking for errors. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend latest version of pyserial in installation instructionsKevin O'Connor2016-12-091-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor updates to wording of some documentsKevin O'Connor2016-12-011-3/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pyhelper: Add ability to route error messages to python loggingKevin O'Connor2016-11-301-1/+1
| | | | | | | Instead of writing error messages to stderr, route them into the python code and use the standard python logging system. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* reactor: Add support for greenletsKevin O'Connor2016-11-291-1/+1
| | | | | | | Add support for greenlets - a mechanism for tasks that can pause while still allowing regular reactor events to occur. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Clarification of some installation and config stepsKevin O'Connor2016-09-151-1/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation.md - Arduino Due is also supportedKevin O'Connor2016-07-281-1/+2
| | | | | | | Update the document introduction to note that the Arduino Due is also now supported. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update documentation with Arduino Due installation infoKevin O'Connor2016-06-141-3/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Initial commit of source code.Kevin O'Connor2016-05-251-0/+118
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 21:12:35 +0000