# Newxt

## Edit files in one pass with instructions via stdin

The following document is for _developers_ contributing to the application. For information about how to _use_ the application, see PACKAGE.md.

## Development setup

Requires Python 3.13 or higher. Uses [Dyngle](https://dyngle.steamwiz.io/) for administration (installed separately)

- `dyngle run init` - Create the virtual environment and install poetry
- `dyngle run dependencies` - Install the required packages using poetry
- `dyngle run test` - Run tests and report coverage (same as CI/CD)
- `dyngle run style` - Run style checks (same as CI/CD)
- `dyngle run build` - Create a test build

GitLab CI/CD performs the entire build/test/release cycle using ProCICD.

## Libraries

The application uses the following external libraries:

- [WizLib](https://wizlib.steamwiz.io/) for CLI and configuration handling
- [ProCICD](https://gitlab.com/procicd/lib) for CI/CD pipeline and job definitions

## References

The `.references` directory contains git submodules of external repositories that provide useful reference material during development. These repositories are read-only references - do not edit their contents directly.

- **.references/guides/** - Coding guidelines and best practices for AI-assisted development
- **.references/procicd-doc/** - Documentation for the ProCICD CI/CD framework
- **.references/procicd-lib/** - ProCICD CI/CD library implementation
- **.references/wizlib/** - WizLib Python CLI framework (a dependency of this project)

<br/>

---

<br/>

<!--<a href="https://www.flaticon.com/free-icons/particles" title="particles icons">Particles icon by Freepik-Flaticon</a>-->
