Skip to content

Commit

Permalink
Update readme and script ready for publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
foxy82 committed Apr 11, 2022
1 parent 1210fea commit cc418ec
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ sudo pip3 install pi_usb_gadget_controller

```
cd ~/pi-usb-gadget-controller
sudo python3 setup.py install
sudo pip3 install .
```

### Running
Expand Down Expand Up @@ -92,7 +92,7 @@ optional arguments:
You can install the server as a service to run on start up:
```
cd ~/pi-usb-gadget-controller
sudo ./install_Service.sh
sudo ./install_service.sh
```

This will use the default options. To change the options edit ```~/pi-usb-gadget-controller/usb_gadget_controller.service``` and edit the ```ExecStart``` line then run ```./install_service.sh``` (first install) or ```./update_service.sh``` (updating)
Expand Down Expand Up @@ -144,9 +144,15 @@ This is a work in progress so there might be times when updating is more complex

## Uninstall

The best bet is to just write a brand new OS onto the SD card however if you do need to remove have a look at ```uninstall_service.sh``` and ```uninstall_usb_gadget.sh``` which removes some files and guides you on other changes needed to remove this.
The best bet is to just write a brand new OS onto the SD card however if you do need to remove...

```
cd ~/pi-usb-gadget-controller
sudo ./uninstall_service.sh # Only if you installed this as a service
sudo ./uninstall_usb_gadget.sh # Follow the additional instructions
sudo pip uninstall pi_usb_gadget_controller
```

You will also need to do a ```pip uninstall pi_usb_gadget_controller```

## Roadmap

Expand Down
7 changes: 1 addition & 6 deletions update.sh
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
#!/bin/bash

# Uncomment if you need to install requirements
# sudo pip3 install -r ./requirements.txt


sudo service usb_gadget_controller stop

sudo python3 setup.py install --force

sudo pip install --no-deps --force-reinstall .
sudo service usb_gadget_controller start

0 comments on commit cc418ec

Please sign in to comment.