Skip to content

Commit

Permalink
Merge pull request #42 from kenkaijie/feature/release-0.0.4-prep
Browse files Browse the repository at this point in the history
release: minor updates for new release
  • Loading branch information
kenkaijie committed Sep 18, 2022
2 parents 7cb0f84 + 6966dfc commit b60edd5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 16 deletions.
15 changes: 5 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,13 @@ A firmware developer develops an application targeting an STM32
microcontroller. This board performs various actions, including interfacing
with an SPI-based NAND flash storage device. The developer either writes this
driver themselves or they use an existing implementation provided by an external
party. Both of these scenarios needs to be integration tested against the rest
of the system.
party. Both of these scenarios needs to be tested.

Using `pyetta`, the developer may simplify their testing of the interaction
between the 2 chips. Depending on the testing approach, the
functionality can be testing either on-target (with the microcontroller
running the tests) or off-target, with a PC running the test on the
microcontroller.
between the microcontroller and the flash chip. Depending on the testing
approach, the functionality can be testing either on-target (with the
microcontroller running the tests) or off-target, with a PC running the test on
the microcontroller.

For on-target testing, `pyetta` CLI tool can assist the process of loading
firmware onto the board, executing the tests, collecting the data for these
Expand All @@ -69,13 +68,9 @@ The project is structured as follows.
```text
root
|---.github: Github specific CI/CD actions
|
|---docs: Documentation for this project
|
|---examples: Examples relating to plugin development.
|
|---pyetta: Project sources
|
|---test: Test directory for project.
```

Expand Down
2 changes: 1 addition & 1 deletion docs/loaders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Pyetta provides a set of built-in loaders for common scenarios.
Implementations
=================

The pyetta library comes with some default loaders for use to upload test runners to devices.
The ``pyetta`` library comes with some default loaders for use to upload test runners to devices.

.. automodule:: pyetta.loaders
:members:
Expand Down
3 changes: 1 addition & 2 deletions docs/plugin_development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
Plugin Development
=======================

This section has guidelines on creating extension plugins for the pyetta
system.
This section has guidelines on creating extension plugins for ``pyetta``.

Click Subcommands
=====================
Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "pyetta"
version = "0.0.4dev2"
version = "0.0.4"
description = "Tooling for automated testing on embedded bare metal platforms."
authors = [
{ name = "Kenneth Ng", email = "ngkaijie@hotmail.com" }
Expand Down Expand Up @@ -49,8 +49,8 @@ dev = [
]

[project.urls]
repository = "https://github.com/kenkaijie/pyetta"
documentation = "https://pyetta.readthedocs.io/"
Repository = "https://github.com/kenkaijie/pyetta"
Documentation = "https://pyetta.readthedocs.io/"

[project.scripts]
pyetta = "pyetta.__main__:main"
Expand Down

0 comments on commit b60edd5

Please sign in to comment.