Skip to content

Commit

Permalink
Modify readme and delete extra workflows
Browse files Browse the repository at this point in the history
  • Loading branch information
kleo-53 committed Sep 20, 2023
1 parent a66dcb6 commit f6ea853
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 59 deletions.
3 changes: 0 additions & 3 deletions .github/workflows/tox-testing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ on:
push:
branches-ignore:
- 'dependabot**'
pull_request:
branches-ignore:
- 'dependabot**'

jobs:
tox:
Expand Down
137 changes: 81 additions & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,87 +1,112 @@
[![build status](https://github.com/kleo-53/trik-studio-pioneer-tool/actions/workflows/tox-testing.yml/badge.svg)](https://github.com/kleo-53/trik-studio-pioneer-tool/actions/workflows/tox-testing.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![GitHub Release (latest by date)](https://img.shields.io/github/v/release/kleo-53/trik-studio-pioneer-tool)](https://img.shields.io/github/v/release/kleo-53/trik-studio-pioneer-tool)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![GitHub Release (latest by date)](https://img.shields.io/badge/release-v1.0.0--alpha-blue)](https://github.com/kleo-53/trik-studio-pioneer-tool/releases/latest)

# Trik Studio Pioneer Tool
Companion tool for [TRIK Studio](https://dl.trikset.com/ts/fresh) to simplify the process of uploading programs to Pioneer quadcopter.

This tool provides an executable file (pioneer-uploader.exe) that integrates with Trik Studio.
This tool provides an executable file ("pioneer-uploader.exe") that integrates with Trik Studio.

# For users
These simple steps will guide you through setting up and using the Trik Studio Pioneer Tool.

## Installation
*Before you begin, make sure you have [TRIK Studio](https://dl.trikset.com/ts/fresh) installed on your machine.*
1. Go to the [Releases section](https://github.com/kleo-53/trik-studio-pioneer-tool/releases) of this repository.
2. Download the pioneer-uploader.exe file from the latest release.
3. Place the downloaded pioneer-uploader.exe file **in the directory where you have Trik Studio installed**.
2. Download the "pioneer-uploader.exe" file from the latest release.
3. Place the downloaded "pioneer-uploader.exe" file **in the directory where you have Trik Studio installed**.

## How to use
1. Open Trik Studio.
2. Create or open your project.
3. When you're ready to upload your program to the quadcopter, simply click the "Upload" button.
The Trik Studio Pioneer Tool will automatically launch and load the program to the quadcopter.
The Trik Studio Pioneer Tool will automatically launch and load the program.

# For developers
## Alternative
If errors continue to occur while using this tool, please try an **alternative way to upload the program** to the quadcopter: install and use the [Pioneer station](https://docs.geoscan.aero/ru/master/programming/pioneer_station/pioneer_station_main.html) program.

## Installation
*Before you begin, make sure you have [Python](https://www.python.org/) (version 3.8 or higher) installed on your system.*
1. Clone repository.
2. Create virtual environment:
```bash
python -m venv venv
```
3. Activate virtual environment:
Windows
```bash
venv\Scripts\activate
```

Linux
```bash
. venv/bin/activate
```
4. Upgrade pip and install requirements:
```bash
pip install --upgrade pip
pip install -r requirements.txt
```
5. Run file with uploading program:
```bash
. venv/bin/activate
```
# For developers
You can build the executable file by yourself or run tests locally.

## Prerequisites
To build the project on your system you will need the following tools:
1. **Python**: Make sure you have Python version 3.8 or higher installed on your system. You can download Python from the [official website](https://www.python.org/).
2. **Git**: If you don't have Git, you can install it:
* On Windows - from the [official site](https://gitforwindows.org/);
* On linux - with the following command:
```
sudo apt-get install git
```

## Installation
0. Open Command Prompt.
1. Clone repository:
```
git clone https://github.com/kleo-53/trik-studio-pioneer-tool.git
```
2. Go to the project directory:
```
cd trik-studio-pioneer-tool
```
3. Create virtual environment:
```bash
python -m venv venv
```
4. Activate virtual environment:
* Windows
```bash
venv\Scripts\activate
```
* Linux
```bash
. venv/bin/activate
```
5. Update `pip` and install the necessary packages
```bash
python.exe -m pip install --upgrade pip
pip install -r requirements.txt
```

Now you can edit the project, build the executable file or run tests locally!

## Build executable
1. Install PyInstaller using `pip`:
```
pip install pyinstaller
```
2. Build the project using PyInstaller:
```
pyinstaller --onefile --name=pioneer-uploader pioneer_uploader.py
```
3. You will find the "pioneer-uploader.exe" file in the **dist** directory.

## Running Tests
You can run tests to ensure the tool's functionality. Tests are available in the test_uploader.py file.
You can run tests to ensure the tool's functionality. Tests are available in the "test_uploader.py" file.
### Manual Testing
Make sure you have pytest installed. You can install it via pip:

```bash
> pip install pytest
```
Run the tests using the following command:

```bash
> pytest test_uploader.py
```
Run tests with pytest module.
1. Install pytest via `pip`:
```
pip install pytest
```
2. Run the tests using the following command:
```
pytest test_uploader.py
```
### Using Tox
Alternatively, you can use Tox for testing. Install Tox via pip:
```bash
> pip install tox
```

Then, simply run Tox:
```bash
> tox
```
Alternatively, you can use Tox for testing.
1. Install Tox via `pip`:
```
pip install tox
```
2. Run Tox:
```
tox
```
## License
This project is licensed under the Apache License 2.0 - see the [LICENSE](https://www.apache.org/licenses/LICENSE-2.0) site for more details.
This project is licensed under the MIT License - see the [LICENSE](https://github.com/git/git-scm.com/blob/main/MIT-LICENSE.txt) site for more details.
## Contributing
Have suggestions or improvements for the Trik Studio Pioneer Tool? Open an [issue](https://github.com/trikset/trik-studio-pioneer-tool/issues) in our repository. We appreciate your feedback and contributions!

Have suggestions or improvements for the Trik Studio Pioneer Tool? Open an [issue](https://github.com/trikset/trik-studio-pioneer-tool/issues) in our repository. We appreciate your feedback and contributions!

0 comments on commit f6ea853

Please sign in to comment.