Skip to content

Commit 2d5adce

Browse files
committed
Update readme
1 parent 6204a20 commit 2d5adce

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
# Refactor
2-
Simplified Recore board image generation toolset, based on Armbian.
2+
Refactor is a Linux distro for Recore based on Armbian.
33

44
[![Build](https://github.com/intelligent-agent/Refactor/actions/workflows/main.yml/badge.svg)](https://github.com/intelligent-agent/Refactor/actions/workflows/main.yml)
55

6-
The starting point for Refactor is the Armbian/Debian console image, details are in the wiki here:
6+
The starting point for Refactor is the Armbian console image, details are in the wiki here:
77
https://wiki.iagent.no/wiki/Refactor
88

9-
Refactor is a build-tool to install a printer's Firmware (at the moment Klipper), a printer control interface (OctoPrint), a touch-screen interface (Toggle w/ OctoPrint) and a few miscellaneous items (webcam streamer, network file share for gcode file uploads, etc.).
9+
This build system will install Klipper and the choice of OctoPrint or Mainsail and Moonraker.
10+
A touch screen interface is also insttalled, either Toggle for OctoPrint or KlipperScreen for Mainsail.
11+
In addition, there are some other programs such as mjpg-streamer to add webcam functionality and the setting up the
12+
right folders and config files so the software is ready to use out of the box.
1013

1114
The hostname for Recore is `recore`.
1215

13-
It sets a default password for access as root on new images, but leaves the root account alone otherwise:
14-
SSH is meant to be active and allow root login. The `debian` user is normally also setup and runs OctoPrint and Klipper. Both root and debian passwords will need to be changed upon first login.
16+
During installation using Reflash, the user can choose to leave the SSH access for user `debian` open or closed. If you choose to have it open, you should log in as user `debian` which will force a change of password. The USB C connector also presents the a serial port which will always allow anyone with physical access to the board to log in. Default passwords are:
1517
Username/password: `root`/`kamikaze`
1618
Username/password: `debian`/`temppwd`
1719

18-
## Usage
19-
The images generated are focused on being a boot-strapped firmware for Thing-Printer control boards, such as Replicape and Recore. However PRs to make ReFactor an image generation tool for a wider range of single-board controllers is completely welcome. To support multiple platforms, the build script usage has been modified:
20+
## Running the image generation on the command line
21+
The images generated are focused on being a boot-strapped firmware for Thing-Printer control boards, such as Replicape and Recore. PRs to make Refactor better are welcome. To support multiple platforms, the build script usage has been modified:
2022
```
2123
cd <path to Refactor git clone>
2224
sudo ./build-image-in-chroot-end-to-end.sh <platform> [OPTIONAL: system setup script]

0 commit comments

Comments
 (0)