/poetry-project-template

Primary LanguageMakefileMIT LicenseMIT

My Awesome Project

this is a project

Repo | Report Bug | Releases



Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact


About The Project

[TODO]

(back to top)

Getting Started

This is a standard Python project that runs on the CLI.

Prerequisites

  • python >= 3.10 (it will probably work with lower versions, but I haven't tested it)
  • poetry >= 1.2

Installation

  1. Install dependencies > poetry install && poetry shell
  2. Install the language model > python -m spacy download de_core_news_sm
  3. Run with [TODO]

(back to top)

Usage

[TODO] Use this space to show useful examples of how a project can be used.

(back to top)

Roadmap

  • Feature 1
  • Feature 2
  • Feature 3
    • Nested Feature

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Fritz, @your_name@mastodon.social

Project Link: https://github.com/gotofritz/german-learning

(back to top)