diff --git a/README.md b/README.md index 2dfd9c9..00a84f0 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,36 @@ # SPL (Software Product Line) Core -_SPL Core_ is our CMake module to support multiple projects as variants of one SPL repository. - -## CI (Continuous Integration) +

+ + CI Status + + + Documentation Status + + + Test coverage percentage + +

+

+ + Poetry + + + ruff + + + pre-commit + +

+

+ + PyPI Version + + Supported Python versions + License +

-- [![selftests](https://github.com/avengineers/spl/actions/workflows/test.yml/badge.svg)](https://github.com/avengineers/spl/actions/workflows/test.yml) +_SPL Core_ is our CMake module to support multiple projects as variants of one SPL repository. ## Installation of Dependencies @@ -21,12 +47,12 @@ _SPL Core_ is our CMake module to support multiple projects as variants of one S .\build.ps1 ``` -## Project Creator +## Initialize a new SPL Project -With the integrated project creator you can create a new SPL workspace, e.g.: +To initialize a new SPL project, one can use the `init` command of the `please.ps1` script. ```powershell -pipenv run python src/project_creator/creator.py workspace --name MyProject --variant MyVariant --out_dir C:\dev +.\please.ps1 init --project-dir C:\tmp\MyProject ``` -Note: one can use the `--variant` argument several times to create a project with multiple variants. +See more information [here](https://spl-core.readthedocs.io/en/latest/getting_started/generate_example_project.html). diff --git a/docs/getting_started/generate_example_project.rst b/docs/getting_started/generate_example_project.rst index 99a91e9..edf4c4b 100644 --- a/docs/getting_started/generate_example_project.rst +++ b/docs/getting_started/generate_example_project.rst @@ -3,37 +3,51 @@ Generate SPL Example Project ============================ -Run Project creator -------------------- +Download SPL Core +----------------- -Clone the SPL Core repository: +You can either install the SPL Core from the Python Package Index (PyPI) .. code-block:: powershell - git clone https://github.com/avengineers/spl-core - + pip install spl-core -Install its dependencies: +or clone the repository from GitHub and install its dependencies: .. code-block:: powershell + git clone https://github.com/avengineers/spl-core cd spl-core .\build.ps1 -install +SPL Core has a command-line interface called ``please``. + +.. note:: + If you have cloned the SPL Core repository you find the ``please`` script in the ``.venv/Scripts`` directory. + +Make sure the installation was successful by running the following command: + +.. code-block:: powershell + + please --help + + +Initialize a new SPL Project +---------------------------- -Activate the python virtual environment and use the project creator to generate the example project: +Generate the example project: .. code-block:: powershell - .\please.ps1 init --project-dir C:\tmp\MyProject + please init --project-dir C:\tmp\MyProject This will create a new SPL project in the directory ``C:\tmp\MyProject``. -Before you can build the project, you need to install the dependencies: +Before you can build the project, you need to install its dependencies. +Change to the project directory and run the following command: .. code-block:: powershell - cd C:\tmp\MyProject .\build.ps1 -install Now you can build the project: @@ -152,7 +166,7 @@ The tools are installed in the user directory under ``scoop``. .. - C:/Users/my_user/scoop/apps + C:/Users//scoop/apps .. note:: diff --git a/src/spl_core/kickstart/templates/project/README.md b/src/spl_core/kickstart/templates/project/README.md new file mode 100644 index 0000000..3d50613 --- /dev/null +++ b/src/spl_core/kickstart/templates/project/README.md @@ -0,0 +1,15 @@ +This is a simple generated SPL project to get you started. + +Install project dependencies: + +```powershell +.\build.ps1 -install +``` + +Build: + +```powershell +.\build.ps1 -build +``` + +See more information [here](https://spl-core.readthedocs.io/en/latest/getting_started/generate_example_project.html).