-
-
Notifications
You must be signed in to change notification settings - Fork 9
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
Showing
2 changed files
with
93 additions
and
0 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 |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # ``ScribbleLab`` | ||
|
|
||
| ScribbleLab's developer documentation | ||
|
|
||
| ## Overview | ||
|
|
||
| Welcome Devs and SL Contributors, This is our Developer documentation that helps our you to understand how our App works in detail. | ||
| ScribbleLab is a powerful text editor built by students, for students, written entirely and unapologetically for iOS, iPadOS and macOS. Features include timetables, reminders, study timers, cloud storage support for 3rd party companies like Google and Apple (iCloudDrive), homework module, powerful text editor, extensions (macOS), live collaboration (soon available) and more. | ||
|
|
||
| > ScribbleLab is currently in development and not yet ready for production use. You are welcome to test the latest [dev build](https://github.com/ScribbleLabApp/ScribbleLab/releases/latest) at your own risk. Please leave any feedback [here](https://github.com/ScribbleLabApp/ScribbleLab/issues). Or build your own version of it `(only development usage)`! | ||
|
|
||
|
|
||
| ## Mission | ||
| Our mission at ScribbleLab is to create an app that makes everyday life easier for many students. | ||
| As a student, you often need to use different apps to organize your academic life. So, we decided to integrate four existing apps, namely Reminder, Calendar, Timetable, and Clock, into one app. We also gave it a new, visually appealing design and a seamless integration into our editor. | ||
|
|
||
|  | ||
|
|
||
| By creating our own text editor, we were able to design it with our workflow in mind and customize its features to our exact specifications. We made sure that the editor was **lightweight but yet powerful**, **fast**, and **user-friendly**. | ||
|
|
||
| We strive to remain true to Apple's human interface guidelines and development patterns, ensuring ScribbleLab looks and feels like an application developed by Apple themselves, which includes a meticulous attention to detail. | ||
|
|
||
| ## Features | ||
| To fulfill our mission, we must provide our users with ... | ||
| 1. ... a visual appealing design. | ||
| 2. ... a great user experience. | ||
| 3. ... awsome features that simplify our user's lives. | ||
|
|
||
| To enhance the visual appeal of our application, we put careful consideration into its design, resulting in a cute and well-coordinated color scheme. | ||
|
|
||
| To ensure a great user experience, we strictly follow Apple's Human Interface Guidelines and development patterns. | ||
|
|
||
| Finally, as a student, you may find many apps with great features, but none that meet all your needs. That's where ScribbleLab comes in handy. Our app provides a comprehensive suite of powerful and useful tools. We offer our users access to: | ||
| - a customizable timetable function | ||
| - a fully customizable Calender | ||
| - a study timer | ||
| - a reminder and homework to-do lists | ||
| - live collaborations `(soon avaiale)` | ||
| - linking cloud storage from 3rd party companies like Dropbox, GoogleDrive, iCloudDrive, ... | ||
| - customizable templates (pages, covers) | ||
| - import and export PDF's, and .scribble `(own file fromat soon available)` files | ||
| - AI support `(ScribbleLab Pro only - soon available)` | ||
| - Widgets: | ||
| - Study Timer widget | ||
| - calender widget | ||
| - reminder and homework to-do widget | ||
|
|
||
| You might wonder, "How can an app be good if it has so many features? Is there a catch?" Our response is no. At ScribbleLab, we believe that our app improves with every feature we add. The purpose of ScribbleLab is to provide a platform where you can make notes related to school, work, or personal life ("scribble") and explore the various features we have to offer and customize them ("Lab"). You may wonder how we can provide users with a straightforward graphical interface, but we have that covered too. To keep the UI simple we moved some of the features into the Side Bar where you can acess it with a simple click. | ||
|
|
||
| But you might wonder "How are they capable of adapting the features to their customers?" - Well the answer is this, we use the feedback from our community and testers. | ||
|
|
||
| ## Community | ||
| Our community comprises of contributors from GitHub, testers, developers, and users. Join our [**Discord server `(coming soon)`**]() for improved communication within and among community members. You as a developer play the most important part of our Community. Be respectful to others and follow the [Code Of Conduct](https://github.com/ScribbleLabApp/ScribbleLab/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| ## Privacy | ||
| We at ScribbleLab believe that privacy is a fundamental right and should be treated with utmost importance. When it comes to personal data, it is important that it is stored securely and responsibly. | ||
| Therefore we're storing your data on your device or on your iCloud/GoogleDrive/Dropbox account, ensuring that the data is not accessible to unauthorized individuals or entities. | ||
|
|
||
| At the same time, it is crucial that individuals have control over their data. They should be able to access and manage their data easily, | ||
| as well as have the option to delete it if they so choose. This is especially important in the context of data breaches, | ||
| where personal information can fall into the wrong hands. But with ScribbleLab it isn't possible accept someone hacks your device or cloud and steals your data. | ||
|
|
||
| When you create a ScribbleLab account, you are agreeing to our [License Agreement](LICENSE_AGREEMENT.md) as well as the licenses of our third-party packages. You might be wondering if it's safe to create an account with ScribbleLab. The answer is yes! We use [Google Firebase](https://firebase.google.com/), which includes [FirebaseAuth](https://firebase.google.com/docs/auth?hl=en), [FirebaseStorage](https://firebase.google.com/docs/storage?hl=en), and [Cloud Firestore](https://firebase.google.com/docs/firestore?hl=en), to securely store your data. This means that no one can access your data, not even us. We cannot see any of your personal data, such as created documents or cloud services. The only thing we can see is how many people have a ScribbleLab account. Furthermore we use Additionally, we use [Google Analytics](https://developers.google.com/analytics?hl=en) and [Google Crashlytics](https://firebase.google.com/docs/crashlytics?hl=en) to track crashes and other unusual events or bugs. | ||
|
|
||
| > Developer note: | ||
| > | ||
| Ensuring the security of our software is a top priority for us, we regularly release software updates that include bug fixes and security | ||
| patches to keep your data and system secure. It is important to install these updates as soon as they become available to ensure that | ||
| you are protected from the latest threats. | ||
|
|
||
| To make the process of updating your software easier, we have implemented an automatic update feature that will prompt you | ||
| to install new updates as soon as they become available. We highly recommend that you enable this feature so that you | ||
| always have the latest security updates installed. | ||
|
|
||
| In addition to automatic updates, we also provide manual update instructions (macOS) on our website. Please make sure to follow these | ||
| instructions carefully to ensure a smooth update process. | ||
|
|
||
| Remember, staying up to date with software updates is an essential part of maintaining the security and integrity of your system. | ||
|
|
||
| > Note: | ||
| > No warranty is provided for testing Alpha, Beta, nightly, or RC builds. Use at your own risk. | ||
| ## Topics | ||
|
|
||
| ### <!--@START_MENU_TOKEN@-->Group<!--@END_MENU_TOKEN@--> | ||
|
|
||
| - <!--@START_MENU_TOKEN@-->``Symbol``<!--@END_MENU_TOKEN@--> |
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