-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
bb2ce85
commit a7e8dbc
Showing
1 changed file
with
44 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,41 +1,64 @@ | ||
| # Fedrock: Advanced Study Material Organizer | ||
|
|
||
| # Fedrock | ||
|  | ||
|
|
||
| A Study Material Organizer. Simplistic UI, File Sorting, Opening Files, Teachers, Subject pre-included. | ||
| Fedrock is a powerful and intuitive study material organizer designed to streamline your educational resources. With its simplistic UI, intelligent file sorting, and seamless integration with subjects and teachers, Fedrock revolutionizes the way you manage your academic content. | ||
|
|
||
| [](https://www.gnu.org/licenses/gpl-3.0) | ||
| [](https://github.com/unknownpersonog/Fedrock/releases) | ||
| [](https://www.python.org/) | ||
|
|
||
| ## 🌟 Features | ||
|
|
||
| - **Intuitive File Organization**: Easily categorize and sort your study materials by subject, teacher, and chapter. | ||
| - **Smart Search**: Quickly find any document or resource with our powerful search functionality. | ||
| - **File Versioning**: Keep track of document revisions and access previous versions effortlessly. | ||
| - **Google Drive Integration**: Seamlessly upload and sync your study materials with Google Drive. | ||
| - **Flashcards**: Create and manage flashcards directly within the app to enhance your learning experience. | ||
| - **Tagging System**: Add custom tags to your files for even more precise organization and retrieval. | ||
| - **Notes**: Attach notes to any file or folder for quick reference and additional context. | ||
| - **Drag and Drop**: Effortlessly add new files to your study material collection with simple drag and drop functionality. | ||
|
|
||
| ## Screenshots | ||
| ## 📸 Screenshots | ||
|
|
||
|  | ||
|  | ||
| <div align="center"> | ||
| <img src="https://files.unknownvps.eu.org/get/file/fedrock-1.png" alt="Fedrock Main Interface" width="45%"> | ||
| <img src="https://files.unknownvps.eu.org/get/file/fedrock-2.png" alt="Fedrock File Management" width="45%"> | ||
| </div> | ||
|
|
||
| ## 🚀 Installation | ||
|
|
||
| ## Installation | ||
| 1. Download the latest build files from the [Releases](https://www.github.com/unknownpersonog/Fedrock/releases) page. | ||
| 2. Extract the downloaded archive to your preferred location. | ||
| 3. Run the Fedrock executable to launch the application. | ||
|
|
||
| Download the build files from [**Releases**](https://www.github.com/unknownpersonog/Fedrock/releases) | ||
| ## 🛠️ Usage | ||
|
|
||
| Copy the icons folder to the running directory, icons can be replaced with your custom ones as long as name remains same | ||
| 1. **Adding Subjects**: Click the "Add Subject" button to create a new subject category. | ||
| 2. **Adding Teachers**: Select a subject and click "Add Teacher" to associate a teacher with that subject. | ||
| 3. **Creating Chapters**: Within a teacher's section, click "Add Chapter" to organize your materials further. | ||
| 4. **Adding Files**: Drag and drop files into the appropriate chapter, or use the "Add File" button. | ||
| 5. **Searching**: Use the search bar to quickly find files across all your subjects and chapters. | ||
| 6. **Google Drive Sync**: Click the "Upload to Google Drive" button to sync your study materials with your Google Drive account. | ||
|
|
||
| No special installation is required. | ||
| ## 🤝 Contributing | ||
|
|
||
| We welcome contributions to Fedrock! If you have suggestions for improvements or encounter any issues, please feel free to open an issue or submit a pull request. | ||
|
|
||
| ## Authors | ||
| ## 👥 Authors | ||
|
|
||
| - [@unknownpersonog](https://www.github.com/unknownpersonog) | ||
| - Project Under [**@UnknownVPS**](https://www.github.com/UnknownVPS) | ||
| - [@unknownpersonog](https://www.github.com/unknownpersonog) - Lead Developer | ||
| - Project maintained under [**@UnknownVPS**](https://www.github.com/UnknownVPS) | ||
|
|
||
| ## 🙏 Acknowledgements | ||
|
|
||
| ## Acknowledgements | ||
| - Icons provided by [Flaticon](https://www.flaticon.com/) | ||
| - Built with [PyQt5](https://www.riverbankcomputing.com/software/pyqt/) | ||
| - Google Drive integration powered by [Google Drive API](https://developers.google.com/drive) | ||
|
|
||
| - Icons are provided by Flaticon | ||
| ## 📄 License | ||
|
|
||
| Fedrock is open-source software licensed under the [GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/). See the [LICENSE](LICENSE) file for more details. | ||
|
|
||
|
|
||
|
|
||
| ## License | ||
|
|
||
| [GNU General Public License v3.0 | ||
| ](https://choosealicense.com/licenses/gpl-3.0/) | ||
|
|
||
| --- | ||
| Built with ❤️ by the Fedrock team. |