diff --git a/README.md b/README.md index 8a857fe..59fac79 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,109 @@ -# Tauri + React + Typescript + -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 +

+ + LearnOnce Logo + +

+

+ An innovative desktop application for efficient note-taking and spaced repetition learning. +

+

+ latest version + License + Downloads Total + CI +

-- [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; + + + + + + +
+ + Download dmg
+ +
+
+ + Download msi
+ Donwloads learn-once.msi
+
+
+ + Download deb
+ Donwloads learn-once.deb +
+
+ +## 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. + + + + \ No newline at end of file diff --git a/assets/logo1.webp b/assets/logo1.webp new file mode 100644 index 0000000..af58f4e Binary files /dev/null and b/assets/logo1.webp differ diff --git a/assets/logo2.webp b/assets/logo2.webp new file mode 100644 index 0000000..249cb88 Binary files /dev/null and b/assets/logo2.webp differ diff --git a/assets/logo3.webp b/assets/logo3.webp new file mode 100644 index 0000000..d161cd2 Binary files /dev/null and b/assets/logo3.webp differ diff --git a/assets/logo4.webp b/assets/logo4.webp new file mode 100644 index 0000000..3666576 Binary files /dev/null and b/assets/logo4.webp differ