Skip to content

Commit

Permalink
docs: update some doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pplmx committed Aug 19, 2024
1 parent f451099 commit 38495fb
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ Try to use a clear title, and describe your problem with complete sentences.

Try to do one pull request per change.

See [Continuous delivery](https://github.com/x-pt/template/blob/main/.github/workflows/cd.yml)
See [Introduce CookieCutter](https://github.com/x-pt/template/pull/13)
as an example.
File renamed without changes.
51 changes: 50 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,58 @@

A [**CookieCutter**](https://github.com/cookiecutter/cookiecutter)-based template designed to serve as a robust starting point for most startup projects hosted on GitHub.

This template aims to streamline the initial setup and provide a solid foundation for new projects, ensuring best practices are followed from the start.

Visit our [website](https://x-pt.github.io) for more details.

## Support
## Features

- **Clean and Modular Structure**: Predefined directory structure to keep your code organized.
- **CI/CD Integration**: Pre-configured GitHub Actions workflows for automated testing and deployment.
- **Pre-configured Linters**: Integrated with some tools to maintain code quality.
- **Docker Support**: Ready-to-use Dockerfile and Docker Compose setup for easy containerization.
- **Customizable Templates**: Modify to fit your project’s specific needs with minimal effort.

## Getting Started

### Prerequisites

- Python 3.6+
- [CookieCutter](https://cookiecutter.readthedocs.io/en/latest/installation.html)

### Installation

To generate a new project using this template:

```bash
cookiecutter gh:x-pt/template
```

### Usage

1. Follow the prompts to customize your project.
2. Navigate to your project directory and review the generated files.
3. Start coding!

For a detailed guide, visit our [documentation](https://x-pt.github.io/docs).

## Example Project

Check out an example project generated with this template:

- [Example C++](https://github.com/x-pt/example-cxx)
- [Example Golang](https://github.com/x-pt/example-go)
- [Example Python](https://github.com/x-pt/example-py)

## Contributing

We welcome contributions! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute to this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

## Acknowledgements

We gratefully acknowledge support from [JetBrains](https://www.jetbrains.com/community/opensource/#support).

Expand Down

0 comments on commit 38495fb

Please sign in to comment.