3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Update documentation with new klipper github URL 

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>
This commit is contained in:
Kevin O'Connor 2021-09-23 19:37:27 -04:00
parent 0b918b357c
commit 44e2c630b3
7 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/Code_Overview.md
View File

@ -381,16 +381,16 @@ Useful steps:
micro-controller communication protocol to a human readable form. micro-controller communication protocol to a human readable form.
5. Add support for timer dispatch from hardware interrupts. See 5. Add support for timer dispatch from hardware interrupts. See
Klipper Klipper
[commit 970831ee](https://github.com/KevinOConnor/klipper/commit/970831ee0d3b91897196e92270d98b2a3067427f) [commit 970831ee](https://github.com/Klipper3d/klipper/commit/970831ee0d3b91897196e92270d98b2a3067427f)
as an example of steps 1-5 done for the LPC176x architecture. as an example of steps 1-5 done for the LPC176x architecture.
6. Bring up basic GPIO input and output support. See Klipper 6. Bring up basic GPIO input and output support. See Klipper
[commit c78b9076](https://github.com/KevinOConnor/klipper/commit/c78b90767f19c9e8510c3155b89fb7ad64ca3c54) [commit c78b9076](https://github.com/Klipper3d/klipper/commit/c78b90767f19c9e8510c3155b89fb7ad64ca3c54)
as an example of this. as an example of this.
7. Bring up additional peripherals - for example see Klipper commit 7. Bring up additional peripherals - for example see Klipper commit
[65613aed](https://github.com/KevinOConnor/klipper/commit/65613aeddfb9ef86905cb1dade9e773a02ef3c27), [65613aed](https://github.com/Klipper3d/klipper/commit/65613aeddfb9ef86905cb1dade9e773a02ef3c27),
[c812a40a](https://github.com/KevinOConnor/klipper/commit/c812a40a3782415e454b04bf7bd2158a6f0ec8b5), [c812a40a](https://github.com/Klipper3d/klipper/commit/c812a40a3782415e454b04bf7bd2158a6f0ec8b5),
and and
[c381d03a](https://github.com/KevinOConnor/klipper/commit/c381d03aad5c3ee761169b7c7bced519cc14da29). [c381d03a](https://github.com/Klipper3d/klipper/commit/c381d03aad5c3ee761169b7c7bced519cc14da29).
8. Create a sample Klipper config file in the config/ directory. Test 8. Create a sample Klipper config file in the config/ directory. Test
the micro-controller with the main klippy.py program. the micro-controller with the main klippy.py program.
9. Consider adding build test cases in the test/ directory. 9. Consider adding build test cases in the test/ directory.

6
docs/Contact.md
View File

@ -106,11 +106,11 @@ bug. Please follow these steps:
experiencing similar issues then you can search the experiencing similar issues then you can search the
[Klipper Community Forum](#community-forum). [Klipper Community Forum](#community-forum).
2. Make sure you are running unmodified code from 2. Make sure you are running unmodified code from
[https://github.com/KevinOConnor/klipper](https://github.com/KevinOConnor/klipper). [https://github.com/Klipper3d/klipper](https://github.com/Klipper3d/klipper).
If the code has been modified or is obtained from another source, If the code has been modified or is obtained from another source,
then you will need to reproduce the problem on the unmodified code then you will need to reproduce the problem on the unmodified code
from from
[https://github.com/KevinOConnor/klipper](https://github.com/KevinOConnor/klipper) [https://github.com/Klipper3d/klipper](https://github.com/Klipper3d/klipper)
prior to reporting an issue. prior to reporting an issue.
3. If possible, run an `M112` command in the OctoPrint terminal window 3. If possible, run an `M112` command in the OctoPrint terminal window
immediately after the undesirable event occurs. This causes Klipper immediately after the undesirable event occurs. This causes Klipper
@ -139,7 +139,7 @@ bug. Please follow these steps:
5. If the log file is very large (eg, greater than 2MB) then one 5. If the log file is very large (eg, greater than 2MB) then one
may need to compress the log with zip or gzip. may need to compress the log with zip or gzip.
5. Open a new github issue at 5. Open a new github issue at
[https://github.com/KevinOConnor/klipper/issues](https://github.com/KevinOConnor/klipper/issues) [https://github.com/Klipper3d/klipper/issues](https://github.com/Klipper3d/klipper/issues)
and provide a clear description of the problem. The Klipper and provide a clear description of the problem. The Klipper
developers need to understand what steps were taken, what the developers need to understand what steps were taken, what the
desired outcome was, and what outcome actually occurred. The desired outcome was, and what outcome actually occurred. The

2
docs/Debugging.md
View File

@ -15,7 +15,7 @@ The source code "whitespace check" can be run with:
The Klippy regression test suite requires "data dictionaries" from The Klippy regression test suite requires "data dictionaries" from
many platforms. The easiest way to obtain them is to many platforms. The easiest way to obtain them is to
[download them from github](https://github.com/KevinOConnor/klipper/issues/1438). [download them from github](https://github.com/Klipper3d/klipper/issues/1438).
Once the data dictionaries are downloaded, use the following to run Once the data dictionaries are downloaded, use the following to run
the regression suite: the regression suite:
``` ```

2
docs/Installation.md
View File

@ -30,7 +30,7 @@ ssh utility to connect to the Raspberry Pi (ssh pi@octopi -- password
is "raspberry") and run the following commands: is "raspberry") and run the following commands:
``` ```
git clone https://github.com/KevinOConnor/klipper git clone https://github.com/Klipper3d/klipper
./klipper/scripts/install-octopi.sh ./klipper/scripts/install-octopi.sh
``` ```

4
docs/_klipper3d/mkdocs.yml
View File

@ -2,8 +2,8 @@
# Site and directory configuration # Site and directory configuration
site_name: Klipper documentation site_name: Klipper documentation
repo_url: https://github.com/KevinOConnor/klipper repo_url: https://github.com/Klipper3d/klipper
repo_name: KevinOConnor/klipper repo_name: Klipper3d/klipper
edit_uri: blob/master/docs/ edit_uri: blob/master/docs/
use_directory_urls: False use_directory_urls: False
docs_dir: '../' docs_dir: '../'

2
docs/beaglebone.md
View File

@ -15,7 +15,7 @@ Then ssh into the beaglebone machine (ssh debian@beaglebone --
password is "temppwd") and install Klipper by running the following password is "temppwd") and install Klipper by running the following
commands: commands:
``` ```
git clone https://github.com/KevinOConnor/klipper git clone https://github.com/Klipper3d/klipper
./klipper/scripts/install-beaglebone.sh ./klipper/scripts/install-beaglebone.sh
``` ```

2
docs/index.md
View File

@ -14,4 +14,4 @@ should use Klipper.
To begin using Klipper start by [installing](Installation.md) it. To begin using Klipper start by [installing](Installation.md) it.
Klipper is Free Software. Read the [documentation](Overview.md) or Klipper is Free Software. Read the [documentation](Overview.md) or
view [the Klipper code on github](https://github.com/KevinOConnor/klipper). view [the Klipper code on github](https://github.com/Klipper3d/klipper).