Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance markdown and wording #14

Merged
merged 2 commits into from
May 16, 2024
Merged

enhance markdown and wording #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d1332a
enhance markdown and wording
svx May 16, 2024
4a2ad52
Apply suggestions from code review
ericof May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,52 @@
<p align="center">
<img alt="Plone Logo" width="200px" src="https://raw.githubusercontent.com/plone/.github/main/plone-logo.png">
</p>

<h1 align="center">
Cookieplone Templates
</h1>

<div align="center">

![GitHub](https://img.shields.io/github/license/plone/cookiecutter-plone)
[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

# Cookieplone Templates
</div>

Powered by [Cookieplone](https://github.com/plone/cookieplone), this is a collection of templates intended to be used by Plone integrators.
## About

## Getting Started 🏁
Powered by [Cookieplone](https://github.com/plone/cookieplone "Link to the GitHub repository of Cookieplone"), this project is a collection of templates intended to be used by Plone integrators.

### Prerequisites
## Prerequisites

- **pipx**: A handy tool for installing and running Python applications.
- **[pipx](https://pipx.pypa.io/stable/ "Link to the website of pipx")**: A tool for installing and running Python applications.

### Installation Guide 🛠️
## Installation 💾

**pipx**
Install `pipx` with the following command:

```shell
pip install pipx
```

### Choose a template 🎉
## Choose a template 🛠️

First run the command:
Select a template with the following command:

```shell
pipx run cookieplone
```

And choose a template:
```
[1/1] Select a template
1 - Backend Add-on for Plone
2 - Frontend Add-on
```text
[1/1] Select a template
1 - Backend Add-on for Plone
2 - Frontend Add-on
```

| Template | Description | |
| --------- | --------- | --------- |
| `Backend Add-on for Plone` | Creates a new Python package to be used with Plone | [Read More](./backend_addon/README.md) |
| `Frontend Add-on for Plone` | Creates a new Node package to be used with Volto | [Read More](./frontend_addon/README.md) |

| `Backend Add-on for Plone` | Create a new Python package to be used with Plone. | [Read More](./backend_addon/README.md) |
| `Frontend Add-on for Plone` | Create a new Node package to be used with Volto. | [Read More](./frontend_addon/README.md) |

## License 📜

Expand Down
15 changes: 8 additions & 7 deletions backend_addon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Cookieplone Backend Add-on

Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter](https://github.com/cookiecutter/cookiecutter), [Cookieplone Backend Add-on](https://github.com/plone/cookieplone-templates/backend_addon) is intended to be used by Plone developers to create new addon packages.
Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter](https://github.com/cookiecutter/cookiecutter), [Cookieplone Backend Add-on](https://github.com/plone/cookieplone-templates/backend_addon) is intended to be used by Plone developers to create new add-on packages.

## Getting Started 🏁

Expand All @@ -20,30 +20,30 @@ Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter
```shell
pip install pipx
```
### Generate Your Plone Addon 🎉

### Generate Your Plone Add-on 🎉

```shell
pipx run cookieplone backend_addon
```


## Project Generation Options

These are all the template options that will be prompted by the [Cookiecutter CLI](https://github.com/cookiecutter/cookiecutter) before generating your project.

| Option | Description | Example |
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
| `title` | Your addon's human-readable name, capitals and spaces allowed. | **Plone Blog** |
| `description` | Describes your addon and gets used in places like ``README.md`` and such. | **Create awesome blogs with Plone.** |
| `title` | Your add-on's human-readable name, capitals and spaces allowed. | **Plone Blog** |
| `description` | Describes your add-on and gets used in places like ``README.md`` and such. | **Create awesome blogs with Plone.** |
| `author` | This is you! The value goes into places like ``LICENSE``, ``setup.py`` and such. | **Our Company** |
| `email` | The email address you want to identify yourself in the project. | **[email protected]** |
| `github_organization` | Used for GitHub and Docker repositories. | **collective** |
| `python_package_name` | Name of the Python package used to configure your project. It needs to be Python-importable, so no dashes, spaces or special characters are allowed. | **collective.blog** |


## Code Quality Assurance 🧐

Your package comes equipped with linters to ensure code quality. Run the following to automatically format your code:
Your package comes equipped with linters to ensure code quality.
Run the following command to automatically format your code:

```shell
make format
Expand All @@ -56,6 +56,7 @@ Generate translation files with ease:
```shell
make i18n
```

## License 📜

This project is licensed under the [MIT License](/LICENSE).
Expand Down
4 changes: 2 additions & 2 deletions frontend_addon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@ Powered by [cookieplone](https://github.com/plone/cookieplone) and [Cookiecutter
```shell
pip install pipx
```

### Generate Your Plone Add-on 🎉

```shell
pipx run cookieplone frontend_addon
```


## Project Generation Options

These are all the template options that will be prompted by the [Cookiecutter CLI](https://github.com/cookiecutter/cookiecutter) before generating your project.
Expand All @@ -42,7 +42,6 @@ These are all the template options that will be prompted by the [Cookiecutter CL
| `npm_package_name` | Name of the Node package, including the organization (if any). | **@plone-collective/volto-weather-block** |
| `volto_version` | Volto version to be used. | **18.0.0-alpha.31** |


## Code Quality Assurance 🧐

Your package comes equipped with linters to ensure code quality. Run the following to automatically format your code:
Expand All @@ -58,6 +57,7 @@ Generate translation files with ease:
```shell
make i18n
```

## License 📜

This project is licensed under the [MIT License](/LICENSE).
Expand Down