Skip to content
This repository was archived by the owner on Sep 10, 2025. It is now read-only.

Merge auto install fixes #100

Draft
HippoProgrammer wants to merge 3 commits into
base: testing
Choose a base branch
from
Draft

Merge auto install fixes #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
086b3b9
Update README.md
HippoProgrammer Jul 8, 2024
e672439
Fix install instructions
HippoProgrammer Jul 8, 2024
2d6843f
Update pyproject.toml
HippoProgrammer Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ For documentation, see [our wiki](https://github.com/Hacking3DPrinters/robotic-c

### Essentials
* 3-core CPU and at least 3GB of RAM (theoretically this can run with only 2 cores and 2GB of RAM, but at the risk of crashing / hanging your computer)
* A Linux-based operating system with sudo OR a Windows 10/11 operating system.
* A Linux-based operating system with sudo OR a Windows 10/11 operating system (more difficult)
* Python 3.10+ and pip
* Octoprint server connected to a 3D printer
* An electromagnet connected to M106/M107 extruder fan control
Expand All @@ -28,23 +28,31 @@ For documentation, see [our wiki](https://github.com/Hacking3DPrinters/robotic-c

## Installation

### Installation from wheel (beta for Linux)
### ~~Installation from wheel (beta for Linux)~~ - SUSPENDED UNTIL FURTHER NOTICE

First, visit [our releases page](https://github.com/Hacking3DPrinters/robotic-chess/releases) and download the `.whl` file from the desired version (the 'latest' version is recommended).
~~First, visit [our releases page](https://github.com/Hacking3DPrinters/robotic-chess/releases) and download the `.whl` file from the desired version (the 'latest' version is recommended).~~

Then, run
```pip install robotic_chess-0.2.1-py3.whl```
(replace 0.2.1 with the version number of your downloaded wheel).
~~Then, run~~
~~```pip install robotic_chess-0.2.1-py3.whl```~~
~~(replace 0.2.1 with the version number of your downloaded wheel).~~

You must then edit `~/.config/octoprint-cli.ini` and input the server details of your octoprint server.
~~You must then edit `~/.config/octoprint-cli.ini` and input the server details of your octoprint server.~~

### Installation from source (recommended for Windows or Linux dev builds)
### Installation from source - Linux (recommended for Linux dev builds)

First, clone our repo using `git clone https://github.com/Hacking3DPrinters/robotic-chess.git`, and enter the new directory.
Then edit `config.ini` with your server details of the octoprint server.

Then run `python3 setup.py install` to begin setup.

### Installation from source - Windows (recommended for Windows)

First, download the `Source code (zip)` from our releases page.

Unzip it, then edit `config.ini` with your server details of the octoprint server.

Then run `python3 setup.py install` to begin setup.

---

## Running
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "robotic_chess"
version = "1.0.2"
version = "1.1.0a1"
authors = [
{ name="Benjamin Porter", email="[email protected]" },
]
Expand Down