I _ Chinese

A tool to help you study HSK vocabulary in context.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Project Description

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

!TODO

Prerequisites

Installation

git clone git@github.com:TAP327/I_Chinese.git

!TODO: Build instructions

(back to top)

Usage

For more examples, please refer to the Documentation

(back to top)

Read The Docs

Currently, docs can only be served and viewed locally. To do so, follow the instructions below to set up and view the docs locally using mkdocs.

Installation

git clone git@github.com:TAP327/I_Chinese.git

(back to top)

Roadmap

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.txt for more information.

(back to top)

Contact

TAP327

NDJSec - @NicolasJanis1 - nicolas.d.janis@gmail.com

Project Link: https://github.com/TAP327/I_Chinese

(back to top)

Acknowledgments

(back to top)