https://github.com/david-swift/flashcards-macos
A native macOS app for studying efficiently
https://github.com/david-swift/flashcards-macos
app flashcards macos swift swiftui
Last synced: about 1 year ago
JSON representation
A native macOS app for studying efficiently
- Host: GitHub
- URL: https://github.com/david-swift/flashcards-macos
- Owner: david-swift
- License: mit
- Created: 2023-05-11T19:29:36.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T19:20:56.000Z (over 2 years ago)
- Last Synced: 2024-01-05T20:30:58.958Z (over 2 years ago)
- Topics: app, flashcards, macos, swift, swiftui
- Language: Swift
- Homepage: https://david-swift.gitbook.io/flashcards/
- Size: 9.96 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Flashcards
User Manual
·
GitHub
·
Download Flashcards
A simple macOS app for studying with flashcards. You can easily study processes with “slides" on the back of a card. With the help feature, show information on a side that is hidden by default. Other features include support for web images, Markdown support, high priority sets, a lot of customization options, keyboard-only navigation, synchronization via [Supabase][1], and more.
![GitHub Banner][image-1]
## Table of Contents
- [Installation][2]
- [Usage][3]
- [Thanks][4]
## Installation
1. Download Flashcards [here][5].
2. Move `Flashcards.app` from the `Downloads` into the `Applications` folder.
3. Press and hold the `Ctrl` key while you click on `Flashcards.app` in the `Applications` folder. Do not launch it from the Launchpad or by double-clicking.
4. Click on `Open`.
5. In the panel that appears now, click on `Open`.
## Usage
* [Getting Started][6]
## Basics
* [Add a Subject][7]
* [Edit a Subject][8]
* [Delete a Subject][9]
* [Add a Set][10]
* [Edit Set Information][11]
* [Delete a Set][12]
* [Add a Flashcard][13]
* [Edit a Flashcard][14]
* [Delete a Flashcard][15]
* [Study a Set][16]
* [Undo and Redo][17]
## Customization
* [Appearance][18]
* [Keyboard Shortcuts][19]
* [Synchronization][20]
## More Information
* [Keyboard Shortcuts][21]
* [Keyboard Shortcut Symbols][22]
* [Markdown][23]
## Thanks
### Dependencies
- [PigeonApp][24] licensed under the [MIT license][25]
- [SwiftLintPlugin][26] licensed under the [MIT license][27]
### Other Thanks
- The [contributors][28]
- [SwiftLint][29] for checking whether code style conventions are violated
- [Supabase][1] that is used as the database
- [Ray Bilcliff][30] whose photos are used in the screenshots
- The programming language [Swift][31]
[1]: https://supabase.com
[2]: #Installation
[3]: #Usage
[4]: #Thanks
[5]: https://github.com/david-swift/Flashcards-macOS/releases/latest/download/Flashcards.app.zip
[6]: user-manual/GettingStarted.md
[7]: user-manual/Basics/AddSubject.md
[8]: user-manual/Basics/EditSubject.md
[9]: user-manual/Basics/DeleteSubject.md
[10]: user-manual/Basics/AddSet.md
[11]: user-manual/Basics/EditSetInformation.md
[12]: user-manual/Basics/DeleteSet.md
[13]: user-manual/Basics/AddFlashcard.md
[14]: user-manual/Basics/EditFlashcard.md
[15]: user-manual/Basics/DeleteFlashcard.md
[16]: user-manual/Basics/StudySet.md
[17]: user-manual/Basics/UndoRedo.md
[18]: user-manual/Customization/Appearance.md
[19]: user-manual/Customization/Shortcuts.md
[20]: user-manual/Customization/Synchronization.md
[21]: user-manual/MoreInformation/Shortcuts.md
[22]: user-manual/MoreInformation/ShortcutSymbols.md
[23]: user-manual/MoreInformation/Markdown.md
[24]: https://github.com/david-swift/PigeonApp-macOS
[25]: https://github.com/david-swift/PigeonApp-macOS/blob/main/LICENSE.md
[26]: https://github.com/lukepistrol/SwiftLintPlugin
[27]: https://github.com/lukepistrol/SwiftLintPlugin/blob/main/LICENSE
[28]: Contributors.md
[29]: https://github.com/realm/SwiftLint
[30]: https://www.pexels.com/@raybilcliff/
[31]: https://github.com/apple/swift
[image-1]: Icons/GitHubBanner.png