Update README (thank you, ChatGPT)

Author: Flegyas

README.md

@@ -4,28 +4,26 @@ A template to bootstrap Python projects following best practices.
 
 ## 🚀 How to Use This Template
 
-You can create a new project using this template in **two ways**:
+You can create a new project in **two ways**:
 
-### 🔹 Option 1: Automatic Setup (Recommended)
-Use the `setup.sh` script to automatically download and set up everything.
+### 🔹 Automatic Setup (Recommended)
+
+Run:
 
 ```bash
 curl -fsSL https://raw.githubusercontent.com/grok-ai/py-template/main/setup.sh -o setup.sh && bash setup.sh
 ```
 
 This will:
-- Prompt you for a project name
-- Install `uv` if not already installed
-- Use **Copier** to create a new project
-- Set up dependencies automatically
-
-### 🔹 Option 2: Manual Setup
-If you prefer a **manual setup**, you can install the required tools and run Copier yourself.
+- Install [uv](https://github.com/astral-sh/uv) if needed.
+- Use [Copier](https://copier.readthedocs.io/en/stable/) to generate the project.
+- Prompt for project configuration (see [Customize the Project](#3-customize-the-project)).
+- (Optionally) set up the environment (dependencies, virtual environment).
+- Initialize Git and optionally push the repository.
 
-#### **📌 Prerequisites**
-Before running Copier manually, ensure you have [`uv`](https://github.com/astral-sh/uv) (for managing dependencies)
+### 🔹 Manual Setup
 
-Install it using:
+Install [uv](https://github.com/astral-sh/uv) and set up Copier:
 
 ```bash
 curl -LsSf https://astral.sh/uv/install.sh | sh
@@ -35,67 +33,82 @@ export PATH="$HOME/.local/bin:$HOME/.cargo/bin:$PATH"
 Then, create a new project with:
 
 ```bash
-uvx copier copy --trust gh:grok-ai/py-template my-new-project
+uvx copier copy --trust gh:grok-ai/py-template <project-folder>
 ```
 
-### 3. Customize the Project
+Once completed, the project will be initialized in `<project-folder>`.
+
+---
+
+## 3. Customize the Project
 
-The script will prompt you for the following configurations:
+During setup, you will be prompted for the following configurations:
 
-- **Project Name**: The name of your new project.
-- **Python Package Name**: The default Python package name (this will be the directory name in lowercase, no spaces).
+- **Project Folder**: Name of the project folder.
+- **Python Package Name**: Defaults to the folder name in lowercase with spaces replaced by underscores.
 - **Description**: A short description of your project.
-- **GitHub Username**: Your GitHub username, if you want to push to a GitHub repository.
-- **GitHub Project Name**: The name of the GitHub repository, if you want to push to a GitHub repository.
-- **License**: Choose a license for your project (e.g., MIT, Apache-2.0).
-- **Pre-commit Hooks**: Choose whether to enable pre-commit hooks for your project.
+- **Maintainers**: A list of maintainers (name & email).
+- **Remote Option** (`remote_option`):
+  - **GitHub**: Push the project to a GitHub repository.
+  - **Manual**: Provide a custom remote URL (e.g., GitHub, GitLab, Bitbucket).
+  - **No Remote**: Skip configuring a remote.
+- **Push to Remote** (`push_to_remote`): If using GitHub or manual, decide whether to automatically push after initialization.
+- **License**: Choose a license (MIT, Apache-2.0).
+- **Use Pre-commit Hooks** (`use_precommit`): Enable or disable pre-commit hooks.
+- **Dependencies**: Define dependencies to install.
+- **Initialize Environment** (`env_init`): Choose whether to set up a virtual environment immediately.
 
-### 4. Manual Push to GitHub (Optional)
+---
 
-If you did not choose to push to GitHub, you can still manually create the repository later and push the project using the following commands:
+## 4. Manual Push to a Remote Repository (Optional)
+
+If `push_to_remote=false` or no remote was set, you can manually add and push later:
 
 ```bash
-# Add the GitHub remote
 git remote add origin https://github.com/your/repository
-
-# Push the project
 git push -u origin main
 ```
 
-### 5. Development Setup
+Use the appropriate URL for GitHub, GitLab, or any other Git host.
+
+---
+
+## 5. Development Setup
 
-Once your project is set up, you can manage the dependencies using `uv`. The setup already takes care of installing `uv` for you and creating a virtual environment in the `.venv` directory.
+Once set up, manage dependencies with uv. The virtual environment is stored in `.venv`.
 
 ---
 
 ## ✨ Features
 
-- **Version Control**: Initialized with Git.
-- **Pre-commit Hooks**: Automatically set up pre-commit hooks for linting and formatting (mostly [Ruff](https://astral.sh/ruff), thanks again, Astral 🚀).
-- **Project Structure**: Follows modern Python project conventions, including a `src/` directory for your main code.
-- **Minimal and simple setup**: We prioritize simplicity, providing a clean and solid foundation to kickstart your project.
+- **Version Control**: Automatically initializes a Git repository.
+- **Optional Remote Push**: Configure a Git remote (GitHub or manual) and optionally push to it.
+- **Pre-commit Hooks**: If enabled, sets up [pre-commit hooks](https://pre-commit.com/).
+- **Modern Project Structure**: Uses an organized `src/` layout.
+- **Flexible**: Simple configuration logic for licensing, dependencies, and environment setup.
 
 ---
 
 ## 🔧 Customization
 
-You can modify this template by editing the following:
+Modify this template by editing:
 
-- **`setup.sh`**: The setup script that runs during initialization. You can add more tasks to automate further project configuration.
-- **`pyproject.toml`**: Customize your project's dependencies, configurations, and settings for tools like `pytest`, `ruff`, and more.
-- **`.pre-commit-config.yaml`**: Customize the pre-commit hooks configuration.
+- `copier.yml`: Adjust or add configuration options.
+- `pyproject.toml`: Define dependencies, linting, and testing configurations.
+- `.pre-commit-config.yaml`: Manage pre-commit hooks.
+- `setup.sh`: Modify automation steps.
 
 ---
 
 ## 📝 License
 
-This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for more details.
+This project is licensed under the **MIT License**. See LICENSE for more details.
 
 ---
 
-### **Support**
+### Support
 
-If you have any issues or suggestions, please feel free to open an issue.
+For issues or suggestions, open an issue on GitHub: https://github.com/grok-ai/py-template/issues
 
 ---