word-generator

Generate words using markov chains

Table of Contents

• Getting Started
  • Prerequisites
  • Initial setup
• Contributing
• Versioning
• Authors
• License
• See also
• Acknowledgments

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You will need python3 with pip3 and jupyter installed on your machine. You can install python from the official website https://www.python.org/. Jupyter can be installed from the official website as well: https://jupyter.org/

Initial setup

A step by step series of examples that tell you how to get a virtual python environment running:

Clone the git repository

git clone https://github.com/umcconnell/python-boilerplate-demo.git

And navigate into the folder

cd python-boilerplate-demo/

Finally, start the jupyter server and open the notebook in the src/ folder:

jupyter lab
# or jupyter notebook depending on your installation

Contributing

Please read CONTRIBUTING.md and CODE_OF_CONDUCT.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Ulysse McConnell - umcconnell

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

See also

Check out the great official python 3 tutorial and especially chapter 12 about virtual environments.

Acknowledgments

• numpy gitignore - Gitignore inspiration
• github python gitignore template - The gitignore template
• python3 tutorial - Guide and explanations
• VirtualEnv - Guide and explanations
• python-virtual-environment-howto - Guide and explanations
• Contributor Covenant - Code of Conduct