Merge pull request #47 from Hacking3DPrinters/testing

Push update 0.2.2

README.md

@@ -1,4 +1,28 @@
 # Robotic Chess
+
 An chess playing robot, powered by Stockfish.
 For documentation, see [our wiki](https://github.com/Hacking3DPrinters/robotic-chess/wiki).
 
+---
+
+## Installation
+
+### Installation from wheel
+
+First, visit [our releases page](https://github.com/Hacking3DPrinters/robotic-chess/releases) and download the `.whl` and `requirements.txt` files from the desired version.
+
+Then, run 
+```pip install robotic_chess-0.2.1-py3.whl```
+(replace 0.2.1 with the version number of your downloaded wheel).
+
+Finally, run 
+```pip install -r requirements.txt```
+to install dependencies.
+
+THIS DOES NOT INSTALL STOCKFISH OR OCTOPRINT (will be included in the future).
+
+### Installation from source 
+
+First, clone our repo using `git clone https://github.com/Hacking3DPrinters/robotic-chess.git`, and enter the new directory. Then do `pip install dist/robotic_chess-0.2.1-py3-none-any.whl` (replace 0.2.1 with the desired version number), followed by `pip install -r requirements.txt`.
+
+THIS DOES NOT INSTALL STOCKFISH OR OCTOPRINT (will be included in the future).

pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=61.0","stockfish==3.28.0"]
+requires = ["setuptools>=61.0"]
 build-backend = "setuptools.build_meta"
 
 [project]

requirements.txt

@@ -0,0 +1,3 @@
+# pip requirements file for robotic-chess
+stockfish==3.28.0
+octoprint-cli==3.3.2

src/robotic_chess/__init__.py

@@ -0,0 +1,3 @@
+import chess
+import gcode
+import __main__

src/robotic_chess/__main__.py

@@ -0,0 +1 @@
+# placeholder

src/robotic_chess/gcode.py

@@ -34,7 +34,10 @@ def add_movement(self,x=0,y=0,z=0,speed=200):
     def add_home(self):
         self.cmd_list.append('G00 X{x} Y{y} Z{z} ; go to set home'.format(x=str(self.home[0]), y=str(self.home[1]), z=str(self.home[2])))
     def add_fan(self,speed=255):
-        self.cmd_list.append('M106 S{s} ; use fan'.format(s=str(speed)))
+        if speed=255:
+            self.cmd_list.append('M106 ; use fan'.format(s=str(speed)))
+        else:
+            self.cmd_list.append('M106 S{s} ; use fan'.format(s=str(speed)))
     def change_pos(self,rel_pos=True):
         if rel_pos:
             self.cmd_list.append('G91 ; set relative position')
@@ -78,4 +81,4 @@ def clear(self):
 
 
 
-
+