From 9b25a71990207c5259969dec0d84e1f4fcf38dd4 Mon Sep 17 00:00:00 2001
From: luc10921 <lucas.uezu@simpli.com.br>
Date: Mon, 19 Jun 2023 17:15:36 -0300
Subject: [PATCH] CU-864drcjjf - CR - changed gitignore and added a better
 explanation on the READMEs

---
 .gitignore                     | 160 ++++++++++++++++++++++++++++++++-
 README.md                      |  10 ++-
 hello_world_template/README.md |   3 +
 3 files changed, 171 insertions(+), 2 deletions(-)
 create mode 100644 hello_world_template/README.md

diff --git a/.gitignore b/.gitignore
index c2fb3c6..0679b9c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,162 @@
-.ideia
+# Neo3-boa generated files
 *.nef
 *.manifest.json
 *.nefdbgnfo
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# IDE
+.idea/
+.vscode/
\ No newline at end of file
diff --git a/README.md b/README.md
index 9a092db..0f45043 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,11 @@
 # Neo3-boa Template
 
-A neo3-boa project template
+A [Neo3-boa](https://github.com/CityOfZion/neo3-boa) project template.
+
+Here, you'll find folders that contains dapp templates, inside each folder there will be a: 
+- folder with the smart contracts needed to program the dapp;
+- folder with unit tests to test the methods of the smart contract;
+- .neo-express file to run a [Neo-Express](https://github.com/neo-project/neo-express#neo-express-and-neo-trace) 
+instance;
+- requirements.txt file that has the python packages needed to compile the smart contract and run the unit tests;
+- README.md with a brief explanation of the dapp.
diff --git a/hello_world_template/README.md b/hello_world_template/README.md
new file mode 100644
index 0000000..14d5d76
--- /dev/null
+++ b/hello_world_template/README.md
@@ -0,0 +1,3 @@
+# Hello World Template
+
+A simple smart contract template to exemplify basic methods used on the Neo Blockchain.