diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c14d38..a6c456a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,14 +24,25 @@ Python installations, the Mac OS X. For Windows, you can use the [pyenv-win](https://github.com/pyenv-win/pyenv-win) port. See [here](https://github.com/pyenv-win/pyenv-win#installation ) for installation -instructions. +instructions. If you use `uv` (recommended and described below), it can install +Python for you, much quicker and easier than using `pyenv`. - This project requires **Python 3.9** or higher. -- We also use [Poetry](https://python-poetry.org/) to manage our dependencies. You -should have this installed as well. You can install Poetry by following the -instructions on the [Poetry -website](https://python-poetry.org/docs/#installation). +- We use [uv](https://docs.astral.sh/uv/) to manage our dependencies. You should +have this installed as well. You can install `uv` by following the instructions +on their [website](https://docs.astral.sh/uv/getting-started/installation/). + +`uv` can be used to actually install Python, even if you do not have it +installed locally (either by system, pyenv or similar). + +For example, to install Python 3.12 using `uv`, you can run the following command: + +```console +uv python install 3.12 +``` + +If you already have a Python version installed, uv will use this. ## Getting Started @@ -54,13 +65,16 @@ To get started, follow these steps: Run the following command to install the required dependencies: ```console -poetry install +uv sync ``` +The `.venv` folder is already in the `.gitignore` file so will not be committed +to the repository. This is where the virtual environment will be created. + You then need to activate the virtual environment: ```console -poetry shell +source .venv/bin/activate ``` From here you can start working on the project. If you are using an IDE such as diff --git a/README.md b/README.md index 83b4390..553fffa 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ Lice generates license files. No more hunting down licenses from other projects. - [Config File](#config-file) - [Integrate into your projects](#integrate-into-your-projects) - [Integration with other tools](#integration-with-other-tools) +- [Contribute to the Development](#contribute-to-the-development) - [Changelog](#changelog) ## Changes from the original 'Lice' project @@ -290,6 +291,23 @@ that can be parsed. For more fine-grained control, you can use the API above (but only in Python) +## Contribute to the Development + +If you want to help with development of this project or just hack on the code, +you can clone the repository and install the development dependencies with the +following command: + +```console +uv sync +``` + +We use [uv](https://docs.astral.sh/uv/) to manage the virtual environment and +dependencies. See [Contributing](CONTRIBUTING.md) and the relevant section on +the [website](https://seapagan.github.io/lice2/) for details + +All contributions are welcome, and I will try to respond to issues and PR's as +soon as possible. + ## Changelog See the [CHANGELOG.md](CHANGELOG.md) file for details for this fork, and the