Skip to content

Commit ddd2fe0

Browse files
authored
Merge pull request #4 from Microsoftlabs/Readme-grammar-patch
Grammar fixes
2 parents fc871f1 + 50ae0fb commit ddd2fe0

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

README.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
## [Zoom AutoRecorder](https://microsoftlabs.github.io/Zoom-AutoRecorder/)
22

33
### Introduction
4-
Zoom Recorder is free and open-source Python based GUI operated screen recorder and scheduler for zoom meetings.
5-
It is complete rewrite of [AutoRecorder](https://github.com/Microsoftlabs/AutoRecorder) with added GUI and reduced bugs.
4+
Zoom Recorder is a free and open-source Python-based GUI-operated screen recorder and scheduler for Zoom meetings.
5+
It is a complete rewrite of [AutoRecorder](https://github.com/Microsoftlabs/AutoRecorder) with added GUI and reduced bugs.
66

77
### How to Use
8-
1. Download the build/code from [here](https://github.com/Microsoftlabs/Zoom-AutoRecorder/releases).
8+
1. Download the binary/code from [here](https://github.com/Microsoftlabs/Zoom-AutoRecorder/releases).
99
2. Run the executable or the main.py file as per the case may be.
10-
3. Install required libraries if you are using source code.
11-
4. [Optional] Then you may make an excutable from the step given [here](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#build-an-executable).Then revert back to step 2.
12-
5. Create a service by entering the details in app GUI homepage.
13-
- In case of doubt you can watch the [walkthrough video](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#video).
10+
3. Install the required libraries if you are using source code.
11+
4. [Optional] Then you can make an executable from the step given [here](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#build-an-executable). Then revert to step 2.
12+
5. Create a service by entering the details in the app's GUI homepage.
13+
- In case of doubt, you can watch the [walkthrough video](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#video).
1414
6. It is always recommended to test against a [Test Meeting](https://zoom.us/test) before joining a real meeting.
15-
7. Make sure that step 1,2,5 of [requirements](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#requirements) are fulfilled.
16-
8. In App GUI, Click on 'Load Pre-created Service'. It will show all the logs of service created in past.
17-
9. Then, Click 'Autoload Suitable Service'.
18-
10. Finally, Click 'Start Service'.
15+
7. Make sure that step 1,2 & 5 of [requirements](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#requirements) are fulfilled.
16+
8. In App GUI, click on 'Load Pre-created Service'. It will show all the logs of service created in the past.
17+
9. Then, click 'Autoload Suitable Service'.
18+
10. Finally, click 'Start Service'.
1919

2020
BOOM! You are ready to use this software like a champ!
2121

@@ -28,81 +28,81 @@ BOOM! You are ready to use this software like a champ!
2828
### Requirements
2929
1. [OBS Studio](https://obsproject.com/) installed at default install location.
3030

31-
2. A scene in OBS Studio named "Zoom Meet" with recording set to Zoom Meeting screen with audio source and mic(If required). It is required only for initial run, not regularly. User just don't have to interfere in "Zoom Meet" Profile afterwards.
32-
- You can do a simple Google Search to know how to create a Scene in OBS Studio.
31+
2. A scene in OBS Studio named "Zoom Meet" with recording set to Zoom Meeting screen with audio source and mic(If required). It is required only for the initial run, not regularly. Users just don't have to interfere in the "Zoom Meet" Profile afterwards.
32+
- You can do a simple Google Search to find out how to create a scene in OBS Studio.
3333

3434
3. [Python v3](https://www.python.org/)
3535

3636
4. Python libraries : datetime, os, errno, sys, tkinter, PIL, time, sqlite3, subprocess, math, platform, webbrowser
37-
38-
(All libraries except PIL,ttkthemes are installed by default in Python)
39-
37+
38+
(All libraries except PIL and ttkthemes are installed by default in Python)
39+
4040
PIL can be installed by using given commands in Terminal/CMD.
4141
```markdown
4242
pip install pillow
4343
OR
4444
pip3 install pillow
4545
```
46-
and
46+
And
4747
```markdown
4848
pip install ttkthemes
4949
OR
5050
pip3 install ttkthemes
5151
```
52-
53-
5. [Zoom Meeting](https://zoom.us/) App Installed with disabled setting for camera on at autojoin and enabled setting for autojoin computer audio on joining meeting.
52+
53+
5. [Zoom Meeting](https://zoom.us/) App Installed with disabled setting for camera on at auto-join and enabled setting for auto-join computer audio on joining meeting.
5454

5555
### Notes
5656
- Recording is supported right now only in Linux and Windows.
57-
- App hasn't been run on windows PC. So possible error may exists.
58-
- It might be possible that bashCommand in LoadService.launchRecordingbyOBS may give error in terminal. User may need to manually modify it.
59-
- Since recording through Linux is through Software Encoding, users may notice high CPU usage of OBS Studio. To fix it user may follow steps given in comments of main.py file.
57+
- The app hasn't been run on Windows OS. So possible errors may exists.
58+
- It might be possible that bashCommand in LoadService.launchRecordingbyOBS may cause an error in the terminal. User may need to manually modify it.
59+
- Since recording through Linux is through Software Encoding, users may notice high CPU usage of OBS Studio. To fix it, user may follow steps given in the comments of main.py file.
6060

6161
### Build an executable
6262
- You can build your own executable by using pyinstaller, Nuitka or any other [compiler](https://pyoxidizer.readthedocs.io/en/stable/pyoxidizer_comparisons.html) that you like.
63-
- First install all required python libraries as per 4th point given in the [instructions](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#requirements).
64-
- Then install your favourite compiler using their documentation.
65-
- For pyinstaller run ```pip3 install pyinstaller``` or ```pip install pyinstaller```
66-
- For Nuitka run ```pip3 install nuitka``` or ```pip install nuitka``` and then you need a [C compiler](https://nuitka.net/doc/user-manual.html#requirements) which will be automatically downloaded on first run, if absent.
67-
- Open the Code directory in the File Explorer and open window powershell or terminal at that location and run the given commands.
68-
- UNIX based Systems(Linux,MacOS etc)
63+
- First install all the required python libraries as per the 4th point given in the [instructions](https://github.com/Microsoftlabs/Zoom-AutoRecorder/edit/main/README.md#requirements).
64+
- Then install your favorite compiler using their documentation.
65+
- For pyinstaller, run ```pip3 install pyinstaller``` or ```pip install pyinstaller```
66+
- For Nuitka, run ```pip3 install nuitka``` or ```pip install nuitka``` and then you need a [C compiler](https://nuitka.net/doc/user-manual.html#requirements) which will be automatically downloaded on first run, if absent.
67+
- Open the Code directory in the File Explorer and open the window PowerShell or terminal at that location and run the given commands.
68+
- UNIX based Systems (Linux, macOS etc.)
6969
```markdown
7070
pyinstaller --noconsole --windowed --add-data "data:data" -i"data/icon.ico" --collect-submodules PIL main.py
7171
```
7272
- Windows
7373
```markdown
7474
pyinstaller --noconsole --windowed --add-data "data;data" -i"data/icon.ico" --collect-submodules PIL main.py
7575
```
76-
- Any OS(es) [Not Recommended to Novice Users]
76+
- Any OS(es) [Not Recommended to Novice Users]
7777
{Unstable;Contains Bug}
7878
```markdown
7979
python3 -m nuitka --standalone --nofollow-imports --remove-output --no-pyi-file --include-package=PIL --include-module=ttkthemes --output-dir=app_build --enable-plugin=tk-inter --onefile --include-data-dir=data=data --windows-icon-from-ico=data/icon.ico main.py
8080
```
8181
- Build will be created in dist directory if using pyinstaller and app_build/main.dist if Nuitka is used.
8282
- Run
8383
- Nuitka on Windows or pyinstaller : Run main.exe or main
84-
- Nuitka on Linux based OS creates shared-library file named 'main' which can be run by opening the terminal in main.dist and typing ```./main```
84+
- Nuitka on Linux-based OS creates a shared-library file named 'main' which can be run by opening the terminal in main.dist and typing ```./main```
8585

8686
### Workaround for Nuitka Build
87-
After building the binary, copy 'ttkthemes' folder from site-packages folder(in lib directory) from your standard python installation location, to remove importing issue.
88-
- To run the binary, open terminal in <Project-location>/app_build/main.dist directory then type and run main.exe or ./main depending on your OS.
87+
After building the binary, copy 'ttkthemes' folder from the site-packages folder(in lib directory) from your standard python installation location, to remove importing issues.
88+
- To run the binary, open terminal in <Project-location>/app_build/main.dist directory, then type and run main.exe or ./main, depending on your OS.
8989

90-
- Running may give a error after the app window is closed.(Any Suggestion/Workaround on this are welcome)
90+
- Running may cause an error after the app window is closed.(Any Suggestions/Workaround on this is welcome)
9191
```
9292
............/zoomRecorder/app_build/main.dist/tkinter/__init__.py", line 4025, in __del__
9393
TypeError: catching classes that do not inherit from BaseException is not allowed
9494
)
9595
```
96-
- Novice Users are warned against using Nuitka build due to its comparatively more complex installation than pyinstaller and increased build size and present bugs in compiling the script on it. (Nuitka builds are performance-wise faster btw)
96+
- Novice users are warned against using the Nuitka build due to its comparatively more complex installation than pyinstaller and increased build size and present bugs in compiling the script on it. (Nuitka builds are faster performance-wise, btw)
9797
9898
### ⚠ Warning
99-
- Since it is in early development phase it might be possible that app may not work at all. Feel free to report any bugs if it exists.
100-
- I admit that UI for loading Service screen is a bit unresponsive on starting service which may be resolved in later updates.
99+
- Since the app is in the early development phase, it might be possible that it may not work at all. Feel free to report any bugs if they exist.
100+
- I admit that the UI for loading the Service screen is a bit unresponsive on starting service, which may be resolved in later updates.
101101
102102
### Roadmap
103-
1. Check if rejoin feature works.
103+
1. Check if the rejoin feature works.
104104
2. Debug the app.
105-
3. Make app feel more responsive.
105+
3. Make the app feel more responsive.
106106
107107
### Preview
108108
[<img src="https://raw.githubusercontent.com/Microsoftlabs/Zoom-AutoRecorder/main/docs/screenshot_collage.jpg"
@@ -116,8 +116,8 @@ height="500">](https://github.com/Microsoftlabs/Zoom-AutoRecorder/tree/main/docs
116116
117117
### Alternatives
118118
- Warning - User discretion required! I don't take any responsibility for any issues faced while using these alternatives.
119-
They are just for informative purpose only. I personally haven't tested either of these except [AutoRecorder](https://github.com/SMazeikis/AutoRecorder).
120-
- It is worth mentioning that some of these alternative work without using any 3rd party recording software, which is a really great feature to look on!
119+
They are just for informative purposes only. I personally haven't tested either of these, except [AutoRecorder](https://github.com/SMazeikis/AutoRecorder).
120+
- It is worth mentioning that some of these alternatives work without using any 3rd party recording software, which is a really great feature to look at!
121121
- Well Documented Repos
122122
- [OZ-Automatic-Recorder](https://github.com/tsamouridis/OZ-Automatic-Recorder)
123123
- [zoom-cli](https://github.com/tmonfre/zoom-cli)

0 commit comments

Comments
 (0)