From 699f65ddc18c5bb0904c507b3c24c102938621cc Mon Sep 17 00:00:00 2001
From: jess <jess@jward.io>
Date: Sat, 1 Sep 2018 00:34:18 +0000
Subject: [PATCH] Additional instructions added
---
README.md | 12 ++++++++++--
setup.py | 15 +++++++++++++++
2 files changed, 25 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 07e374e..4ca9615 100644
--- a/README.md
+++ b/README.md
@@ -6,9 +6,17 @@ when it senses lights are off in the room.
It's written in Python 3 and requires a photoresistor-capacitor circuit
connected to a Raspberry Pi running Snapcast.
-# Setup
+# Setup/Usage
+* `sudo pip install DarkMute`
+* `darkmute.py`
+
+To run this as a service, create a systemd service definition. Instructions pending.
+
+# Developer Setup
+
+* Clone this from [gitlab](https://git.xhost.io/jess/Dark-Mute)
* Create and activate Python 3 virtual env
* `pip install -e .` to install dependencies
* Build the circuit, connected to GPIO Pin 7
-* add user to gpio group [/dev/gpiomem] (https://raspberrypi.stackexchange.com/a/40106)
+* add user to gpio group [/dev/gpiomem](https://raspberrypi.stackexchange.com/a/40106)
diff --git a/setup.py b/setup.py
index 1e6cdf0..3565678 100644
--- a/setup.py
+++ b/setup.py
@@ -1,12 +1,27 @@
from setuptools import setup, find_packages
+with open("README.md", "r") as fh:
+ long_description = fh.read()
setup(
name="DarkMute",
version="0.1",
+ author="Jessica Ward",
+ description="Mute snapcast client playing on raspi3",
+ long_description=long_description,
+ long_description_content_type="text/markdown",
+ url="https://git.xhost.io/jess/Dark-Mute",
packages=find_packages(),
+ scripts=['darkmute.py'],
install_requires=[
"RPi.GPIO==0.6.3",
"snapcast==2.0.8"
+ ],
+ classifiers=[
+ "License :: OSI Approved :: MIT License",
+ "Intended Audience :: System Administrators",
+ "Intended Audience :: Developers",
+ "Programming Language :: Python :: 3",
+ "Topic :: System :: Hardware"
]
)
--
GitLab