Code Monkey home page Code Monkey logo

chinese-prestudy's Introduction

Chinese-Prestudy

Chinese-Prestudy is an Anki 2.1 plugin that helps you generate flashcards for a body of text so that you can learn the text's vocabulary before you read it.

There is more information, including usage instructions, in this blog post.

Travis Build Status Appveyor Build Status

Developing

If you want to contribute back to this project, follow these instructions:

Setup

  1. You'll want a computer running Linux. macOS may work too. Windows will not.
  2. You need Anki 2.1 installed.
  3. Install Python dependencies:
pip3 install --user chinesevocablist chineseflashcards genanki jieba cached_property pystache pyyaml

Running

To try out your code, run

make install

and restart Anki to see the effects. You may need to uninstall your existing copy of the plugin if you got it from AnkiWeb, otherwise you'll have two copies of the plugin installed.

There are also some (currently, not very many) unit tests. You can run those with

make test

Some changes may belong in chinesevocablist, chineseflashcards, or genanki. If you want to change one of these packages, check it out from GitHub, make your change, and then run make install in the package's directory followed by make install in this directory and restart Anki.

Publishing

If your name is Kerrick, you can publish new versions to AnkiWeb by following these steps:

  1. Run ./package.py to generate package.ankiaddon.
  2. Install package.ankiaddon in Anki, and restart. Test thoroughly.
  3. Go to https://ankiweb.net/shared/upload?id=882364911 and upload the new version of the package.

chinese-prestudy's People

Contributors

kerrickstaley avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.