Skip to content

Commit

Permalink
Merge branch 'main' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
xerosanyam committed Jun 25, 2024
2 parents d7476cd + dc448ab commit ce6c892
Showing 1 changed file with 5 additions and 46 deletions.
51 changes: 5 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,9 @@
# Remfo (Remember Forever) 🧠
# remfo (Remember Forever)

Welcome to Remfo, a project aimed at helping you learn things more effectively and remember them forever! 🚀
hi there

## Project Overview ℹ️
this is that space of the internet where we welcome learners

Remfo, short for Remember Forever, is inspired by the concept of spaced repetition, similar to the popular tool Anki. Anki helps users transfer information from short-term memory to long-term memory through spaced repetition algorithms. While Anki offers many customizations and is free to use, the challenge lies in dedicating consistent time for revisions.
more talk soon

To address this challenge, we plan to publish Remfo as a Chrome extension apart from standalone web app.

## Features 🛠️

With Remfo, whenever you open a new page, you have two options:

A) **Add New Stuff**: Easily input new information that you'd like to remember for future revision sessions.

B) **Revise Old Stuff**: Quickly review previously saved content to reinforce your memory.

## Get Involved! 💻

Interested in contributing to Remfo? Whether you're a developer, designer, or simply passionate about improving learning experiences, there's a place for you in our community! Join us in shaping the future of Remfo.

## How to begin 🛠️

Are you a new developer looking to get involved with Remfo? Fantastic! Here's how you can start:

1. **Clone the Repository**: First, clone the Remfo repository to your local machine using Git.

```bash
git clone https://github.com/xerosanyam/remfo.git
```

2. **Install Dependencies**: Navigate into the project directory and install dependencies using npm, pnpm, or yarn.

```bash
cd remfo
npm install
```

3. **Start Development Server**: Once dependencies are installed, start a development server using the following command:

```bash
npm run dev
```

This will launch the Remfo app in your default web browser, allowing you to begin development.

---

_Happy Learning!_ 📚
@xerosanyam

0 comments on commit ce6c892

Please sign in to comment.