From 6e584841157c3654a30b6cb0de4d50d5cb69054f Mon Sep 17 00:00:00 2001 From: JulianPienaar <104741835+JulianPienaar@users.noreply.github.com> Date: Mon, 23 Oct 2023 16:54:51 +0200 Subject: [PATCH] Update README.md --- README.md | 79 ++++++++++++++++--------------------------------------- 1 file changed, 23 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 9e87088f..d3f79b67 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,40 @@ # WriteToPdf [![codecov](https://codecov.io/gh/COS301-SE-2023/WriteToPdf/branch/main/graph/badge.svg?token=2CELOVRCM3)](https://codecov.io/gh/COS301-SE-2023/WriteToPdf) -[![Build](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/build.yml) [![Test Backend](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/test-backend.yml/badge.svg?branch=main)](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/test-backend.yml) [![Test Integration](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/test-integration.yml/badge.svg?branch=main)](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/test-integration.yml) -[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=COS301-SE-2023_WriteToPdf&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=COS301-SE-2023_WriteToPdf) +[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=COS301-SE-2023_WriteToPdf&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=COS301-SE-2023_WriteToPdf) +[![Issues closed](https://img.shields.io/github/issues-closed/COS301-SE-2023/WriteToPdf?color=blue)](https://github.com/COS301-SE-2023/WriteToPdf/issues?q=is%3Aissue+is%3Aclosed) ![GitHub issues](https://img.shields.io/github/issues/COS301-SE-2023/WriteToPdf) -[![Issues closed](https://img.shields.io/github/issues-closed/COS301-SE-2023/WriteToPdf?color=blue)](https://github.com/COS301-SE-2023/WriteToPdf/issues?q=is%3Aissue+is%3Aclosed) +[![Build](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/COS301-SE-2023/WriteToPdf/actions/workflows/build.yml) -
- - - + - + - + - + + +
+ +
+ +## WriteToPdf advertisement +https://github.com/COS301-SE-2023/WriteToPdf/assets/104741835/bcbb9573-0dbd-4e79-8830-f0e11453c501 ## Description WriteToPdf is a user-friendly ecosystem that enables the conversion of handwritten notes into structured documents that can be edited and shared with others. @@ -192,14 +195,10 @@ Julian has experience with design patterns and data structures giving him a good -
- -## System summary -Placeholder where we show a video demo (like our demo 4 presentation but for non technical people) as well as a slideshow summary of the app. - -## WriteToPdf advertisement -https://github.com/COS301-SE-2023/WriteToPdf/assets/104741835/bcbb9573-0dbd-4e79-8830-f0e11453c501 + +## System demo +A demonstration of our entire system can be found over here: [System Demo](https://drive.google.com/file/d/1rBJz_qG9DlVLB606aOAsoBIKaSgG-CCx/view?usp=share_link) ## Research and implementation decisions @@ -217,39 +216,7 @@ Placeholder for a tutorial of the system (description of how to use the app?) ## How to Use WriteToPdf -1. **Accessing The App**: - - WriteToPdf is a web application available from [official website](https://app.writetopdf.com). - -2. **Account Setup**: - - In the WriteToPdf app sign in or create a new account if you don't already have one. - -3. **File Management**: - - Create documents to begin editing or create folders for better organization. Multiple operations can be performed on documents and folders such as renaming, moving, deleting and opening. These operations can be accessed by right clicking on the file item or by clicking on the context menu button to the right of the file item. - -4. **Editing Your Document**: - - The editor provides multiple options for changing a document to suit your needs such as font size, font colour, tables, bolding and so much more. - -5. **Uploading An Image Asset**: - - Click on the plus icon in the asset sidebar and upload from camera or from file system. Then the image will appear in the asset sidebar. - -6. **Converting Handwritten Text To Digital Form**: - - Click on the plus icon in the asset sidebar and upload from camera or from file system. Check the extract text and or extract table checkbox. The text asset will appear in the asset sidebar. - -7. **Export**: - - Export your document to various formats such as PDF, HTML, or plain text. - -8. **Share**: - - Click on the share button or right click on a document in the home menu and click share. Type in the user email of the user to which you want to share. - -9. **Safe Lock Your Document**: - - In the home page right click on a document and click lock document. Enter a password longer than 8 characters. The document is now securely locked and will require the password on all subsequent opeings of the document. - -10. **Version Control**: - - Every time you save a new version of the document is created. Go to the history sidebar to interogate, roleback and make copies of previous document versions. - -11. **Refer to the User Manual**: - - For more detailed instructions and advanced features, consult the [WriteToPdf User Manual](https://drive.google.com/file/d/1ORl7Xf34JZsVV1Nfj6ZIbAzdHSDzqgas/view?usp=sharing). It provides comprehensive guidance on using all aspects of the application. - +link to wiki ## Contributing