diff --git a/docs/assets/ex_qtcowsay.gif b/docs/assets/ex_qtcowsay.gif new file mode 100644 index 0000000..c603040 Binary files /dev/null and b/docs/assets/ex_qtcowsay.gif differ diff --git a/docs/changelog.md b/docs/changelog.md index e69de29..53828d7 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -0,0 +1,3 @@ +## v0.1.0 + +First release of `box`. diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 0000000..9335f59 --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,35 @@ +## Pre-requisites + +In all of the following examples, we assume that: + +1. The python environment used for the specific project is set up. +2. Cargo is installed and available (see [pre-requisites](index.md#pre-requisites)). +2. `box` is installed and available. + + +## qtcowsay + +The following is an example on how to use `box` with a GUI project. +We will use [`qtcowsay`](https://github.com/trappitsch/qtcowsay), +a simple PyQt6 wrapper around +[`cowsay`](https://github.com/VaasuDevanS/cowsay-python), as an example. + +![GIF showing box in action using qtcowsay](assets/ex_qtcowsay.gif) + +### Step-by-step instructions + +0. Clone the repository and navigate to the project directory. In the example case, the project is setup using `rye`. +1. Initialize this project as a `box` project by typing `box init`. + 1. Choose a builder: Here we choose `rye` (default). + 2. Provide optional dependnecies - not necessary for this project (default). + 3. Answer if this is a GUI project: Yes. + 4. Provide the app entry point: The automatically selected point is correct, so we choose from the list - option 0. + 5. Choose the App entry type according to PyApp's options: Here we use `spec`. + 6. Provide the Python version to package with: Here we use the default `3.12`. + 7. Provide additonal PyApp variables: Not required here (default). +2. After successfull initialization, we package the project with `box package`. This first builds the package and then packages it with PyApp. Hold on... +3. The executable is now in `target/release`. +4. Run the executable! + +!!! note + Packaging the project the first time will take a while. Use `box package -v` to get verbose output to follow the progress. diff --git a/docs/index.md b/docs/index.md index 158c9d4..61acba8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,11 +39,6 @@ Instructions to do so can be found ## Installation -!!! failure - - The installation from `pypi` (top part from given options below) is currently not available. - If you want to test this project, please use the installation from github. - !!! abstract "Installation Instructions" {% include-markdown ".includes/install.md" %} diff --git a/mkdocs.yml b/mkdocs.yml index c6aabf8..acf7af9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -51,3 +51,4 @@ nav: - CLI: cli.md - Usage guide: guide.md - Changelog: changelog.md + - Examples: examples.md