Skip to content

Commit 3a2c566

Browse files
committed
Created documentation for all pages in the app
1 parent 49abee3 commit 3a2c566

File tree

7 files changed

+52
-5
lines changed

7 files changed

+52
-5
lines changed
-107 KB
Binary file not shown.

.vs/CodeCapture/v16/.suo

-274 KB
Binary file not shown.
-107 KB
Binary file not shown.

.vs/GarudaHacks/v16/.suo

-70.5 KB
Binary file not shown.

CodeCapture/CodeCapture/README.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,50 @@
1-
# Details Of All Content Pages Present
1+
# User Interface of the Application
22

3-
# Work Under Progress
3+
The application consists of the various Content Pages that the user sees when they use the app. The details and purpose of each page that
4+
5+
You can check out the [demo video here](https://drive.google.com/file/d/1Dso3XfNttYl8mPMorpG0CSG9iAkEF5rS/view?usp=sharing) as well.
6+
7+
## 1. Entering the App
8+
9+
![MainPage](https://drive.google.com/file/d/1Dz5kPgKgHxIdgEO_RLvFCOW89cJtZ0vH/view?usp=sharing)
10+
11+
* Page: MainPage.xaml
12+
* Code: MainPage.xaml.cs
13+
14+
The **MainPage.xaml** page is the first page that a user will see when they start the app. Tapping on the logo will allow them to proceed further.
15+
16+
## 2. Capturing An Image
17+
18+
![ImageCapture](https://drive.google.com/file/d/1DxoDN47ENrBCsRe6PtODIpXMm_Ct6QpF/view?usp=sharing)
19+
20+
* Page: ImageCapture.xaml
21+
* Code: ImageCapture.xaml.cs
22+
23+
The **ImageCapture.xaml** page is where the user will capture (click or select) the image of handwritten code that they want to check using the app.
24+
25+
## 3. Extracting The Code
26+
27+
![ExtractText](https://drive.google.com/file/d/1E35OIzsNDR9xIVaLji_IbK6MMbG9rasa/view?usp=sharing)
28+
29+
* Page: ExtractText.xaml
30+
* Code: ExtractText.xaml.cs
31+
32+
The **ExtractText.xaml** page is where the code extracted from the image using the **Azure Computer Vision Read API** shall be displayed. The user can edit the code here in the in-built editor to correct any errors in the extracted code. The user will also have to select the programming language of the code here and can add any "Standard Input" they might want to.
33+
34+
## 4. Compiling The Code And Displaying Output
35+
36+
![CompileCode](https://drive.google.com/file/d/1E3dhg49f0bJbk2ZgfJZGQE8iCPBiwI0T/view?usp=sharing)
37+
38+
* Page: CompileCode.xaml
39+
* Code: CompileCode.xaml.cs
40+
41+
The **CompileCode.xaml** page is where the result of the code is returned by the **JDoodle Compiler API**. In case there are any errors in the code. Those shall be displayed here as well.
42+
43+
## Emailing The Result
44+
45+
![EmailResult](https://drive.google.com/file/d/1E0GRDvEYYeSg3ESJ-J68sZkCG7CE1QIF/view?usp=sharing)
46+
47+
* Page: EmailResult.xaml
48+
* Code: EmailResult.xaml.cs
49+
50+
The **EmailResult.xaml** page allows the user to email the extracted code, Standard Input, and result to any email address of their preference.

CodeCapture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Open the CodeCapture folder to find all the Content Pages that you will see when you run the app and their backend code
1+
Open the **CodeCapture** folder in this directory to find all the Content Pages that you will see when you run the app (along with their backend code)

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
* Check out the [demo video](https://drive.google.com/file/d/1Dso3XfNttYl8mPMorpG0CSG9iAkEF5rS/view?usp=sharing)
1212

13-
* Download the [Android APK (for testing)](https://drive.google.com/file/d/1Y5xGoUFr09ClH-GQLYCUfc9XKse86nws/view?usp=sharing)
13+
* Download the [Android APK](https://github.com/adityaoberai/CodeCapture/releases/tag/v1.0-beta) *(for testing)*
1414

1515

1616
## Inspiration
@@ -32,7 +32,7 @@ The following **NuGet** packages are necessary to build and run this project:
3232

3333
* [Xam.Plugin.Media](https://www.nuget.org/packages/Xam.Plugin.Media/5.0.1?_src=template)
3434

35-
* [NETStandard.Library (SDK)](https://www.nuget.org/packages/NETStandard.Library/2.0.3?_src=template)
35+
* [NETStandard.Library](https://www.nuget.org/packages/NETStandard.Library/2.0.3?_src=template) (SDK)
3636

3737

3838
## Steps To Run

0 commit comments

Comments
 (0)