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

Jump to bottom

Add template setting description #46

Merged
merged 1 commit into from
Nov 9, 2020
Merged

Add template setting description #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 12 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,24 @@ It is recommended to set up Python 3.7, 3.8, or 3.9 using pyenv_.
Creating a project
------------------

Generate a Home Assistant custom component project by using the following command
and setting the different parameters of the template:
Generate a Home Assistant custom component project by using the following command:

.. code:: console

$ cookiecutter gh:oncleben31/cookiecutter-homeassistant-custom-component \
--checkout="2020.10.30"

Follow the instructions to customize the generated project

================= ============================================
Setting Definition
================= ============================================
``friendly_name`` Integration name used in configuration UI.
``project_name`` Project name on GitHub.
``domain_name`` Integration domain name
``github_user`` GitHub user hosting the repository
``version`` Initial version of the component
================= ============================================

Change to the root directory of your new project,
and create a Git repository:
Expand Down