Make sure you have Python installed on your system. You can download Python from python.org.
-
Clone the Repository:
First, you need to clone the repository. Open your terminal and run:
git clone https://github.com/xjodoin/gptchangelog.git cd src
-
Create a Virtual Environment (Optional but Recommended):
It's a good practice to create a virtual environment to avoid dependency conflicts. Run the following commands:
python -m venv venv source venv/bin/activate # On Windows use `venv\Scripts\activate`
-
Install the Required Dependencies:
With your virtual environment activated, install the project dependencies using
setup.py
:pip install .
If you are developing the project and need to install it in editable mode, use:
pip install -e .
You can verify the installation by running the gptchangelog
command:
src --help
-
Running Tests: (if applicable)
If your project includes tests, you can run them with:
pytest
-
Uninstalling:
To uninstall the project, simply run:
pip uninstall src
- Common Issues: Provide solutions for common issues here.
- Support: Include information on how to get support if they run into problems (e.g., creating an issue on GitHub).