Skip to content

Commit

Permalink
Fixes #223 Docs: Update to latest information
Browse files Browse the repository at this point in the history
Also added a badge for the docs build to the README
  • Loading branch information
markfinal committed Jan 4, 2025
1 parent 37e0455 commit aa48a0e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Conan recipe user interface
Written by Mark Final.

![main action workflow](https://github.com/markfinal/cruiz/actions/workflows/main.yml/badge.svg)

![Latest documentation](https://img.shields.io/readthedocs/cruiz)

## Documentation
See the documentation at [Read The Docs](https://cruiz.readthedocs.io/).
Expand Down
18 changes: 13 additions & 5 deletions doc/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,23 @@ More details can be found, for example, in the [tutorial](https://code.visualstu
VisualStudio Code has been configured in the cruiz source workspace to format and lint code automatically.

## Tox
Tox is used to run both flake8 and mypy for linting and static analysis. flake8 plugins are used to cover a number of areas.

Add the necessary tools to your Python 3 virtual environment using `pip install -r requirements_dev.txt`.

Running tox is as simple as
```
tox -e lint
tox
```

### Linting
Tox is used to run both flake8, mypy and pylint for linting and static analysis. flake8 plugins are used to cover a number of areas.

Add the necessary tools to your Python 3 virtual environment using `pip install -r requirements_dev.txt`.

The `lint` tox environment contains all the commands.

### Testing
tox also manages running pytest for any tests to run.

The `test` tox environment contains all the commands.

## Code format
cruiz uses [black](https://pypi.org/project/black/) as a formatter.

Expand Down
7 changes: 6 additions & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
cruiz stands for Conan Recipe User Interface.

At this time, only Conan 1.x is supported in versions 1.3.x.
However, there are alpha releases of Cruiz 1.4.0 that dual support Conan 2.x (from v2.0.7), reusing most of the existing UI.

Both Conan 1.x and 2.x (from v2.0.14) are supported in versions 1.4.x and in the latest development code. Most of the existing UI is reused, and cruiz will modify its UI based on the major version of Conan present in the Python environment.

## Goals
The goals of cruiz are as follows:
Expand Down Expand Up @@ -162,10 +163,14 @@ Split into three sections, it shows:
Modifying any input data to the lockfile generation will recompute the package_id.

### Local workflow dock
*Not available when Conan 2.x is used.*

Split into several sections, this allows the definition of paths used in Conan local workflows.

### Conan command dock
Whenever a command is executed on a recipe, it is recorded in the command log. This is intended both as a learning mechanism by seeing what changes by modifying a recipe's configuration, but also as a reproducible mechanism as right clicking over a command allows exporting it to different shells.

### Conan log dock
*Not available when Conan 2.x is used.*

Running Conan commands captures logging from Conan itself, which is displayed in this dock. This is for diagnostic purposes only really.

0 comments on commit aa48a0e

Please sign in to comment.