Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Jordan Maxwell committed Apr 25, 2023
1 parent 91cb354 commit 9240b4c
Showing 1 changed file with 33 additions and 4 deletions.
37 changes: 33 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,37 @@
<img src="https://static.wikia.nocookie.net/frstarwars/images/e/e4/Logo_Droid_Depot_SWGE.png/revision/latest?cb=20200730141444" align="right" width="150">

# PyDroid

PyDroid is an open-source project that aims to provide Python access to the Starwars Galaxy's Edge droid depot droids. It allows users to manually control their custom built droids
using custom applications.
PyDroid is an open-source project that aims to provide Python access to the Starwars Galaxy's Edge droid depot droids. It allows users to manually control their custom built droids using custom applications.

## License
PyDroid is released under the MIT license. See the LICENSE file for more details.
## Installation

PyDroid can be installed using `pip`, or by downloading the source code and running the `setup.py` script.

### Installing with pip

To install PyDroid using `pip`, simply run:

```
pip install pydroid
```

### Installing from source

To install PyDroid from source, follow these steps:

1. Download the source code from the [GitHub repository](https://github.com/thetestgame/pydroid).
2. Extract the contents of the archive to a directory of your choice.
3. Navigate to the directory containing the `setup.py` script.
4. Run the following command:

```
python setup.py install
```

## Examples

PyDroid comes with a few examples to help users get started. These examples can be found under the `examples` directory in the repository root.

## License
PyDroid is released under the MIT license. See the LICENSE file for more details.

0 comments on commit 9240b4c

Please sign in to comment.