You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,11 +18,11 @@ To use this boilerplate:
18
18
```
19
19
3. Answer the questions about the project.
20
20
- `project_name`: This is the "human-readable" name of your project. For example, "Dash Core Components".
21
-
- `project_shortname`: is derived from the project name, it is the name of the "python library" for your project. By default, this is generated from your `project_name` by lowercasing the name and replacing spaces & `-` with underscores. For example, for "Dash Core Components" this would be "dash_core_components".
22
-
- `component_name`: This is the name of the initial component that is generated. As a javascript class name it should be in PascalCase. defaults to the PascalCase version of `project_shortname`.
21
+
- `project_shortname`: is derived from the project name, it is the name of the "Python library" for your project. By default, this is generated from your `project_name` by lowercasing the name and replacing spaces & `-` with underscores. For example, for "Dash Core Components" this would be "dash_core_components".
22
+
- `component_name`: This is the name of the initial component that is generated. As a JavaScript class name it should be in PascalCase. defaults to the PascalCase version of `project_shortname`.
23
23
- `r_prefix`: Optional prefix for R components. For example, `dash_core_components` uses "dcc" so the Python `dcc.Input` becomes `dccInput` in R, and `dash_table` uses "dash" to make `dashDataTable`.
24
24
- `author_name` and `author_email`: for package.json and DESCRIPTION (for R) metadata.
25
-
- `github_org`: If you plan to push this to github, enter the organization or username that will own it (for URLs to the project homepage and bug report page)
25
+
- `github_org`: If you plan to push this to GitHub, enter the organization or username that will own it (for URLs to the project homepage and bug report page)
26
26
- `description`: the project description, included in package.json.
27
27
- `license`: License type for the component library. Plotly recommends the MIT license, but you should read the generated LICENSE file carefully to make sure this is right for you.
28
28
- `publish_on_npm`: Set to false to only serve locally from the package data.
@@ -41,7 +41,7 @@ to generate the components in the `build:py_and_r` script of the generated
41
41
- Learn more about Dash: https://dash.plot.ly
42
42
- Questions about this project? Create an issue: https://github.com/plotly/dash-component-boilerplate/issues/new
43
43
- Watch the [component boilerplate repository](https://github.com/plotly/dash-component-boilerplate) to stay informed of changes to our components.
44
-
- [React guide for python developers](https://dash.plot.ly/react-for-python-developers)
44
+
- [React guide for Python developers](https://dash.plot.ly/react-for-python-developers)
45
45
- Need help with your component? View the Dash Community Forum: https://community.plot.ly/c/dash
46
46
- Examples of Dash component libraries include `dash-core-components`: https://github.com/plotly/dash-core-components and `dash-html-components`: https://github.com/plotly/dash-html-components.
47
47
- To get a feel for what's involved in creating a component, read through the [README.MD file that this cookiecutter project generates](%7B%7Bcookiecutter.project_shortname%7D%7D/README.md)
0 commit comments