Skip to content
This repository was archived by the owner on Apr 7, 2026. It is now read-only.

Commit 6d63729

Browse files
committed
docs: Streamline README and eliminate duplication
- Reduce README.md to focus on quick start and essential information - Point users to comprehensive documentation site for detailed guides - Move template options overview to documentation index - Ensure all README content is preserved in documentation: * Quick start guide has detailed usage instructions * Template options fully documented in configuration guide * All features and tools explained in dedicated docs - Maintain clear navigation with direct links to documentation sections - Improve user experience by reducing information overload in README README now serves as a concise entry point while comprehensive documentation provides all detailed information.
1 parent 2b6f633 commit 6d63729

2 files changed

Lines changed: 34 additions & 55 deletions

File tree

README.md

Lines changed: 20 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -17,72 +17,37 @@ pip install cookiecutter
1717
cookiecutter https://github.com/s-celles/cookiecutter-python-package.git
1818
```
1919

20-
## 📋 Usage
20+
That's it! You'll be prompted to customize your package with modern tools like **Ruff**, **pytest**, **MyPy**, and choice of **build backends** (setuptools, hatchling, flit, pdm).
2121

22-
After generating your project:
22+
## ✨ What You Get
2323

24-
1. **Navigate to your project**: `cd your-project-name`
25-
2. **Set up development environment**: `pip install -e .[dev]`
26-
3. **Configure tools**: Choose from Ruff, MyPy, pytest, pre-commit, and more
27-
4. **Start developing**: Write your code in `src/` with tests in `tests/`
28-
5. **Run quality checks**: `make lint`, `make test`, `make type-check`
29-
6. **Commit and push**: Pre-commit hooks ensure code quality
30-
31-
For detailed setup instructions, see our [Quick Start Tutorial](docs/getting-started/quick-start.md).
32-
33-
## ⚙️ Template Options
34-
35-
Customize your generated project by choosing from these options:
36-
37-
- **Build Backend**: setuptools, hatchling, flit, or pdm
38-
- **Code Quality**: Ruff, MyPy, Bandit, Safety
39-
- **Testing**: pytest, coverage reporting
40-
- **Documentation**: MkDocs or Sphinx
41-
- **CLI Framework**: Typer, Click, Argparse, or none
42-
- **Package Management**: uv or pip
43-
- **Automation**: pre-commit, GitHub Actions, Dependabot
44-
45-
See [Template Configuration](docs/configuration/template-options.md) for all available options.
46-
47-
## ✨ Features
48-
49-
- 📦 Modern `pyproject.toml` configuration (PEP 621)
50-
- 🧪 Testing with pytest and coverage
51-
- 🔍 Code quality with Ruff, MyPy, Bandit, Safety
52-
- 🔧 Optional tools: uv, pre-commit, Tox, Nox
53-
- 🚀 CI/CD with GitHub Actions
54-
- 📚 Documentation with Sphinx or MkDocs
55-
- 🐳 Docker and dev container support
56-
- 🛠️ CLI support with Typer/Click/Argparse
24+
- 📦 **Modern packaging** with `pyproject.toml` (PEP 621)
25+
- 🏗️ **Build backend choice** (setuptools, hatchling, flit, pdm)
26+
- 🧪 **Testing** with pytest and coverage
27+
- 🔍 **Code quality** with Ruff, MyPy, Bandit, Safety
28+
- 🚀 **CI/CD** with GitHub Actions
29+
- 📚 **Documentation** with MkDocs or Sphinx
30+
- 🛠️ **CLI support** with Typer, Click, or Argparse
31+
- 🐳 **Container support** with Docker and dev containers
5732

5833
## 📖 Documentation
5934

60-
For complete documentation, visit: **[Documentation Site](https://s-celles.github.io/cookiecutter-python-package)**
61-
62-
### Quick Links
63-
64-
- [Installation Guide](docs/getting-started/installation.md)
65-
- [Quick Start Tutorial](docs/getting-started/quick-start.md)
66-
- [Template Configuration](docs/configuration/template-options.md)
67-
- [Available Tools](docs/tools/overview.md)
68-
- [Contributing Guide](docs/development/contributing.md)
35+
**For complete documentation, examples, and detailed guides:**
6936

70-
## 📚 What's Included
37+
### 🔗 **[Visit Documentation Site →](https://s-celles.github.io/cookiecutter-python-package)**
7138

72-
The generated package includes:
39+
The documentation includes:
7340

74-
- Source layout with `src/` directory
75-
- Comprehensive testing setup
76-
- Code quality tools and linting
77-
- CI/CD workflows
78-
- Documentation framework
79-
- Development tools and automation
80-
- Security scanning
81-
- Type checking support
41+
- **[Quick Start Guide](https://s-celles.github.io/cookiecutter-python-package/getting-started/quick-start/)** - Step-by-step setup
42+
- **[Template Options](https://s-celles.github.io/cookiecutter-python-package/configuration/template-options/)** - All configuration choices
43+
- **[Tools Overview](https://s-celles.github.io/cookiecutter-python-package/tools/overview/)** - Detailed tool explanations
44+
- **[Examples](https://s-celles.github.io/cookiecutter-python-package/getting-started/examples/)** - Real-world usage patterns
45+
- **[Build Backends Guide](https://s-celles.github.io/cookiecutter-python-package/tools/build-backends/)** - Choose the right backend
46+
- **[Contributing Guide](https://s-celles.github.io/cookiecutter-python-package/development/contributing/)** - Help improve the template
8247

8348
## 🤝 Contributing
8449

85-
See our [Contributing Guide](docs/development/contributing.md) for details on how to contribute to this project.
50+
We welcome contributions! See our [Contributing Guide](https://s-celles.github.io/cookiecutter-python-package/development/contributing/) for details.
8651

8752
## 📝 License
8853

docs/index.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,20 @@ Choose your preferred CLI framework:
4949
- **Click** (decorator-based)
5050
- **Argparse** (standard library)
5151

52+
## ⚙️ Template Options Overview
53+
54+
Customize your generated project by choosing from these options:
55+
56+
- **Build Backend**: setuptools, hatchling, flit, or pdm
57+
- **Code Quality**: Ruff, MyPy, Bandit, Safety
58+
- **Testing**: pytest, coverage reporting
59+
- **Documentation**: MkDocs or Sphinx
60+
- **CLI Framework**: Typer, Click, Argparse, or none
61+
- **Package Management**: uv or pip
62+
- **Automation**: pre-commit, GitHub Actions, Dependabot
63+
64+
See [Template Configuration](configuration/template-options.md) for detailed explanations of all options.
65+
5266
### 📚 **Documentation Ready**
5367
- **MkDocs** or **Sphinx** support
5468
- **README** templates with badges

0 commit comments

Comments
 (0)