Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Felipe Gusmao committed Sep 7, 2024
1 parent 7d20110 commit 68df67d
Show file tree
Hide file tree
Showing 5 changed files with 98 additions and 36 deletions.
134 changes: 98 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,109 @@
# Tauri + React + Typescript
<!-- packages -->

This template should help get you started developing with Tauri, React and Typescript in Vite.
[downloads-shield]: https://img.shields.io/github/downloads/YOUR_GITHUB_USERNAME/learn-once/total
[macos-shield]: https://api.iconify.design/logos/macos.svg
[macos-pkg]: https://github.com/YOUR_GITHUB_USERNAME/learn-once/releases/download/vLATEST_VERSION/learn-once_LATEST_VERSION_x64.dmg
[windows-shield]: https://api.iconify.design/logos/microsoft-windows.svg
[windows-pkg]: https://github.com/YOUR_GITHUB_USERNAME/learn-once/releases/download/vLATEST_VERSION/learn-once_LATEST_VERSION_x64_en-US.msi
[linux-deb-shield]: https://api.iconify.design/logos/linux-tux.svg
[linux-deb-pkg]: https://github.com/YOUR_GITHUB_USERNAME/learn-once/releases/download/vLATEST_VERSION/learn-once_LATEST_VERSION_amd64.deb

## Recommended IDE Setup
<p align="center">
<a href="https://learn-once.com/app">
<img src="assets/logo3.webp" alt="LearnOnce Logo" width="299">
</a>
</p>
<p align="center">
An innovative desktop application for efficient note-taking and spaced repetition learning.
</p>
<p align="center">
<a href="https://github.com/YOUR_GITHUB_USERNAME/learn-once/releases"><img src="https://badge.fury.io/gh/YOUR_GITHUB_USERNAME%2Flearn-once.svg" alt="latest version"></a>
<a href="https://github.com/YOUR_GITHUB_USERNAME/learn-once/blob/master/LICENSE"><img src="https://img.shields.io/github/license/YOUR_GITHUB_USERNAME/learn-once.svg" alt="License"></a>
<a href="https://img.shields.io/github/downloads/YOUR_GITHUB_USERNAME/learn-once/total"><img src="https://img.shields.io/github/downloads/YOUR_GITHUB_USERNAME/learn-once/total.svg" alt="Downloads Total"></a>
<a href="https://github.com/YOUR_GITHUB_USERNAME/learn-once/actions/workflows/test.yml"><img src="https://github.com/YOUR_GITHUB_USERNAME/learn-once/actions/workflows/test.yml/badge.svg?branch=dev" alt="CI"></a>
</p>

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
## Why LearnOnce?

Template created! To get started run:
cd learn-once
npm install
npm run tauri android init
npm run tauri ios init
- 📝 **Capture and Review** - Organize your notes and create flashcards seamlessly.
- 🔁 **Spaced Repetition** - Optimize learning with scientifically proven techniques.
- 💡 **Minimalist Design** - Focused, distraction-free interface for enhanced learning.
- 🦀 **Built with Rust** - Fast, efficient, and secure cross-platform application.
- 🌐 **Cross-platform** - Available on Linux, macOS, and Windows.

For Desktop development, run:
npm run tauri dev
# LearnOnce :thought_balloon:
## Key Features

For Android development, run:
npm run tauri android dev
> Master technical knowledge with a powerful combination of note-taking and flashcard-based learning.
For iOS development, run:
npm run tauri ios dev
- :bookmark_tabs: Create and manage notes with ease.
- :flashlight: Automatically convert notes into flashcards for review.
- :alarm_clock: Use spaced repetition for long-term knowledge retention.
- 🌑 Dark and light modes available for a comfortable learning experience.
- :computer: Available on Linux, macOS, and Windows.
- **Efficient Note Management:** Create, organize, and manage your notes with ease. Syntax highlighting and markdown support enhance your note-taking experience.
- **Spaced Repetition Learning:** Transform your notes into flashcards and leverage spaced repetition algorithms for optimized learning and long-term retention.
- **Intuitive User Dashboard:** A centralized hub to track your study progress, upcoming card reviews, and overall learning journey.
- **Secure and User-Friendly:** Enjoy a safe and intuitive environment designed to support your learning goals.

# TODO:
## Download & Installation

- publish tauri package
- website For Learn Once app
- document most important
- review cards study session logic and address bugs
You can download the latest version of LearnOnce here:

yes | npx shadcn-ui@latest add calendar;
yes | npx shadcn-ui@latest add select;
yes | npx shadcn-ui@latest add scroll-area;
yes | npx shadcn-ui@latest add switch;
yes | npx shadcn-ui@latest add label;
yes | npx shadcn-ui@latest add textarea;
yes | npx shadcn-ui@latest add avatar;
yes | npx shadcn-ui@latest add dropdown-menu;
yes | npx shadcn-ui@latest add popover;
yes | npx shadcn-ui@latest add tabs;
yes | npx shadcn-ui@latest add separator;
yes | npx shadcn-ui@latest add resizable;
yes | npx shadcn-ui@latest add tooltip;
yes | npx shadcn-ui@latest add image;
yes | npx shadcn-ui@latest add badge;
yes | npx shadcn-ui@latest add button;
<table width="100%">
<tr>
<td align="center">
<a href="https://learn-once.com/download/vLATEST_VERSION/learn-once_LATEST_VERSION_x64.dmg">
Download dmg<br/>
<svg xmlns="http://www.w3.org/2000/svg" width="80" height="80" viewBox="0 0 26 26"><path fill="currentColor" d="M23.934 18.947c-.598 1.324-.884 1.916-1.652 3.086c-1.073 1.634-2.588 3.673-4.461 3.687c-1.666.014-2.096-1.087-4.357-1.069c-2.261.011-2.732 1.089-4.4 1.072c-1.873-.017-3.307-1.854-4.381-3.485c-3.003-4.575-3.32-9.937-1.464-12.79C4.532 7.425 6.61 6.237 8.561 6.237c1.987 0 3.236 1.092 4.879 1.092c1.594 0 2.565-1.095 4.863-1.095c1.738 0 3.576.947 4.889 2.581c-4.296 2.354-3.598 8.49.742 10.132M16.559 4.408c.836-1.073 1.47-2.587 1.24-4.131c-1.364.093-2.959.964-3.891 2.092c-.844 1.027-1.544 2.553-1.271 4.029c1.488.048 3.028-.839 3.922-1.99"/></svg>
</a>
</td>
<td align="center">
<a href="https://github.com/YOUR_GITHUB_USERNAME/learn-once/releases/download/vLATEST_VERSION/learn-once_LATEST_VERSION_x64_en-US.msi">
Download msi<br/>
<img src="https://api.iconify.design/logos/microsoft-windows.svg" alt="Donwloads learn-once.msi" height="100" width="120" /><br/>
</a>
</td>
<td align="center">
<a href="https://github.com/YOUR_GITHUB_USERNAME/learn-once/releases/download/vLATEST_VERSION/learn-once_LATEST_VERSION_amd64.deb">
Download deb<br/>
<img src="https://api.iconify.design/logos/linux-tux.svg" alt="Donwloads learn-once.deb" height="100" width="120" />
</a>
</td>
</tr>
</table>


## Contributing

We welcome contributions from the community! If you have any suggestions, bug reports, or feature requests, please open an issue
or submit a pull request.

## License

Distributed under the [**MIT License**](LICENSE).  


## Acknowledgments

This project wouldn't be possible without the amazing work of the maintainers and contributors of these projects:

- [Tauri](https://tauri.app/)
- [ProseMirror](https://github.com/ProseMirror/)
- [Vite](https://github.com/vitejs/vite)
- [Rust](https://www.rust-lang.org/)

## How is LearnOnce made?

- **[Tauri](https://www.tauri.app)** - A secure, fast, and lightweight framework for building desktop apps.
- **[NextJS](https://yew.rs)** - Framework for creating web applications.
- **[TailwindCSS](https://tailwindcss.com)** - A utility-first CSS framework.


## Donations

LearnOnce is a free and open-source project. If you find it valuable, please consider supporting its development through a donation.

<a href="https://www.buymeacoffee.com/YOUR_USERNAME">
<img style="width: 192px" src="https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-1.svg" />
</a>
Binary file added assets/logo1.webp
Binary file not shown.
Binary file added assets/logo2.webp
Binary file not shown.
Binary file added assets/logo3.webp
Binary file not shown.
Binary file added assets/logo4.webp
Binary file not shown.

0 comments on commit 68df67d

Please sign in to comment.