GithubHelp home page GithubHelp logo

abishekmuthian / memory-hammer Goto Github PK

View Code? Open in Web Editor NEW
28.0 4.0 0.0 3.64 MB

An always-on Anki review system.

Home Page: https://memoryhammer.com

License: GNU Affero General Public License v3.0

Python 100.00%
anki anki-deck anki-flashcards memory spaced-repetition raspberry-pi raspberry-pi-zero-w

memory-hammer's Introduction

Memory Hammer

An always-on Anki review system.

Memory Hammer Demo

Click the above image for a video demo.

Why

To solve Anki review accumulation by making the cards available for review when its due using always-on display system. By extension addressing Human Memory, lack of thereof.

How

Using e-paper display attached to a raspberry pi and memory-hammer software.

Features

  1. Supports basic cards with plain text.
  2. Review Anki Cards and set Ease Factor.
  3. When a card is due, it's automatically displayed.

Requirements

  1. Raspberry Pi Zero.
  2. 2.13inch Touch e-Paper HAT.
  3. Python 3.10.
  4. Anki Desktop with Anki Connect.

Installation

  1. Set up the Raspberry Pi Zero with the e-paper hat using Raspberry Pi OS(Headless is fine).
  2. Install the latest version of RPi.GPIO.
  3. Set up Anki Connect on the desktop with ANKICONNECT_BIND_ADDRESS.
  4. git clone https://github.com/abishekmuthian/memory-hammer.git
  5. pip3.10 install -r requirements.txt

Usage

  1. Edit the Config section of the memory_hammer.py with the IP address of your Anki Desktop and port for Anki Connect.
  2. python3.10 memory_hammer.py

Download the Decks using Get Decks

Download the decks

Select 'All' if you don't want to select the decks individually

Select All decks

Select the deck for review using arrow buttons

Select the deck for review

Front-side of the card is displayed, Select show answer to show the back-side

Front side of the card is displayed

Back-side of the card is displayed, Select the Ease Factor

Back side of the card is displayed

  • A: Again
  • H: Hard
  • G: Good
  • E: Easy

If there are no due-cards available, It will be automatically retrieved and displayed

No due cards

Misc

  • If the display has ghosting effects, Refresh the screen using the refresh button on the left.
  • Select the Home button to navigate to the Home screen.

Short-term project goals

  • Improving the performance.
  • Improving the stability.
  • Adding more features through feedback.

Long-term project goals

  • Make the project more accessible to non-technically inclined Anki users.

Achievement of those goals depends upon the support I receive from you.

Support

If you think Memory Hammer is useful for you, Support the continuous development of Memory Hammer.

Built in Public

Memory Hammer is being built in public here - https://twitter.com/Abishek_Muthian/status/1521340206611574785 .

License for Memory Hammer

Memory Hammer, An always on Anki-review system.

Copyright (C) 2022 Abishek Muthian (www.memoryhammer.com).

This program is free software: you can redistribute it and/or #modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public #License along with this program. If not, see https://www.gnu.org/#licenses/.

License for libraries included within Memory Hammer

Licenses for libraries used in Memory Hammer are included within those library files.

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.