Added short usage sequence.

Added src dir

Added __main__.py

Removed hyphen from project name

Author: Cecron

README.md

@@ -3,10 +3,25 @@
 [Copier](https://copier.readthedocs.io/) is a library for rendering project templates, which lives at [github.com/copier-org/copier](https://github.com/copier-org/copier/).
 [Poetry](https://python-poetry.org/) makes Python packaging and dependency management easy using pyproject.toml, and lives at [github.com/python-poetry/poetry](https://github.com/python-poetry/poetry/)
 
-This copier template is my first attempt at using these two tools togehter to make creating new Python projects easier.
+This copier template is my first attempt at using these two tools togehter to make creating new Python projects easier on Windows.
 
 ## Usage
 
+I'm more of a traditionalist and want the virtual environment files in a .venv directory in each project, so I have done:
+``` shell
+PS C:\> poetry config virtualenvs.in-project true
+```
+This will globally configure poetry to do so and will let me do the following:
+
+``` shell
+PS C:\> copier https://github.com/Cecron/copier-python.git myproj
+PS C:\> cd myproj
+PS C:\> poetry install
+PS C:\> py -3 -m venv .\.venv\ --prompt .  # Set virtual env prompt to show directory name
+PS C:\> .venv\Scripts\activate.ps1
+```
+
+
 To give a basic understanding of how to create and use a copier template, I'll show how the first versions of this template was created, including how to apply the template to both generate a new project and also how to update the project whith a an improved version of the template.
 
 ### Create a directory to place the template in
@@ -44,7 +59,7 @@ pytest = "^5.2"
 
 ``` shell
 PS C:\copier-template> type copier.yaml
-package_name: my-package
+package_name: mypackage
 package_description: A short description of the package.
 author_name: Cecron
 author_email: Cecron@example.com
@@ -81,7 +96,7 @@ PS C:\copier-template> cd ..
 PS C:\> copier copier-template myproj
 # Answer questions
 package_name? Format: yaml
-🎤 [my-package]:
+🎤 [mypackage]:
 
 package_description? Format: yaml
 🎤 [A short description of the package.]:
@@ -147,7 +162,7 @@ PS C:\copier-template> cd ..
 PS C:\> copier update myproj
 
 package_name? Format: yaml
-🎤 [my-package]:
+🎤 [mypackage]:
 
 package_description? Format: yaml
 🎤 [A short description of the package.]:

README.md.tmpl

@@ -0,0 +1,54 @@
+# [[ package_name ]]
+
+[[ package_description ]]
+
+## Installation
+
+Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.
+
+```shell
+pip install [[package_name]]
+```
+
+## Usage
+
+Use from within your Python code:
+
+```python
+import [[ package_name ]]
+
+...
+```
+
+Use from command-line:
+
+```shell
+[[ package_name ]]
+# or
+python -m [[ package_name ]]
+# or
+poetry run [[ package_name ]]
+
+```
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+[[ author_name ]] <[[ author_email ]]>
+
+## License
+[[ copyright_license ]]
+

copier.yaml

@@ -1,11 +1,10 @@
-package_name: my-package
+package_name: mypackage
 package_description: A short description of the package.
 author_name: Cecron
 author_email: Cecron@example.com
 copyright_license: "CC-BY-4.0"
 
 _exclude:
     - ".git"
-    - "README.md"
     # Don't match emacs backup files
     - "*~"

pyproject.toml.tmpl

@@ -9,10 +9,16 @@ description = "[[ package_description ]]"
 authors = ["[[ author_name ]] <[[ author_email ]]>"]
 maintainers = ["[[ author_name ]] <[[ author_email ]]>"]
 license = "[[ copyright_license ]]"
-readme = "README.rst"
+readme = "README.md"
+packages = [
+         { include = "[[ package_name ]]", from = "src" },
+]
 
 [tool.poetry.dependencies]
 python = "^3.8"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"
+
+[tool.poetry.scripts]
+[[ package_name ]]  = "[[ package_name ]].app:main"

src/[[ package_name ]]/__main__.py

@@ -0,0 +1,3 @@
+from . import app
+
+app.main()

src/[[ package_name ]]/app.py

@@ -0,0 +1,4 @@
+
+
+def main():
+    print("Hello world")