-
Notifications
You must be signed in to change notification settings - Fork 99
/
README.md
283 lines (176 loc) · 10.8 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
<!-- Banner -->
<div class="container-fluid">
<img class="mx-auto" src="assets/banner.png">
</div>
## Learning Made Easy
<!--[](#contributors-)-->
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
[](https://forthebadge.com)
## 📌 Introduction
The project, ***Learning Made Easy*** has been designed for the convenience of students who are planning for the preparation of any kind of examination. It will help them to understand how to study different subjects, and the topics within them and how much time should they give to everything and keeps a track of their learning rate of each student and hence personalise their experiences as well, so that it can optimize the time assigned for learning each subject in future. It will help you build a deeper knowledge about Data Structure and Algorithms and understand their applications in our life in a more efficient manner. It aims at scheduling the studies for maximizing marks during exams. Most students face this problem during exams that what to study to get the best out of their limited time. Also it helps the early beginners to start with the most important subjects so that they have enough time for the most important subjects and then if time permits they can go ahead with less important subjects. Apart from this, it schedules the subjects as the way user wants to.
<br><br>
## ⭐ Understanding the Program :cupcake:
<br>
<br>
## ⭐ How to get started?
[](https://forthebadge.com) <br>
You can refer to the following articles on the basics of Git and Github and also contact the Project Mentors, in case you are stuck:
- [Watch this video to get started, if you have no clue about open source](https://youtu.be/SL5KKdmvJ1U)
- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-a-pull-request)
- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github)
- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6)
- [Join the workspace to join the community of contributors](https://join.slack.com/t/opensourcecon-q6c3969/shared_invite/zt-kkqg4h5t-G3euksLSmBI4PJ3lg6WbrA)
<br>
## ⭐ Steps to follow :scroll:
<br>
### 1️⃣ Fork it :fork_and_knife:
You can get your own fork/copy of [Learning-Made-Easy](https://github.com/anushka23g/Learning-Made-Easy) by using the <kbd><b>Fork</b></kbd> button.
<br>
### 2️⃣ Clone it :busts_in_silhouette:
You need to clone (download) it to local machine using
```sh
$ git clone https://github.com/Your_Username/Learning-Made-Easy.git
```
> This makes a local copy of repository in your machine.
Once you have cloned the `Learning-Made-Easy` repository in Github, move to that folder first using change directory command on linux and Mac.
```sh
# This will change directory to a folder Learning-Made-Easy
$ cd Learning-Made-Easy
```
Move to this folder for all other commands.
<br>
### 3️⃣ Set it up :arrow_up:
Run the following commands to see that *your local copy* has a reference to *your forked remote repository* in Github :octocat:
```sh
$ git remote -v
origin https://github.com/Your_Username/Learning-Made-Easy.git (fetch)
origin https://github.com/Your_Username/Learning-Made-Easy.git (push)
```
Now, lets add a reference to the original [Learning-Made-Easy](https://github.com/anushka23g/Learning-Made-Easy) repository using
```sh
$ git remote add upstream https://github.com/anushka23g/Learning-Made-Easy.git
```
> This adds a new remote named ***upstream***.
See the changes using
```sh
$ git remote -v
origin https://github.com/Your_Username/Learning-Made-Easy.git (fetch)
origin https://github.com/Your_Username/Learning-Made-Easy.git (push)
upstream https://github.com/anushka23g/Learning-Made-Easy.git (fetch)
upstream https://github.com/anushka23g/Learning-Made-Easy.git (push)
```
<br>
### 4️⃣ Sync it :recycle:
Always keep your local copy of repository updated with the original repository.
Before making any changes and/or in an appropriate interval, run the following commands *carefully* to update your local repository.
```sh
# Fetch all remote repositories and delete any deleted remote branches
$ git fetch --all --prune
# Switch to `master` branch
$ git checkout master
# Reset local `master` branch to match `upstream` repository's `master` branch
$ git reset --hard upstream/master
# Push changes to your forked `Learning-Made-Easy` repo
$ git push origin master
```
<br>
### 5️⃣ Ready Steady Go... :turtle: :rabbit2:
Once you have completed these steps, you are ready to start contributing by checking our `Help Wanted` Issues and creating [pull requests](https:/anushka23g/Learning-Made-Easy/github.com//pulls).
<br>
### 6️⃣ Running the work on your local machine :computer:
To run the code and play with the app on your local machine, do:
* `if os == 'Windows'`:
* We have tested the code in **Dev C++ IDE** and **Code Blocks IDE** **(Both running MINGW)**.
* To run the code in any IDE, simply open the file, click `Execute > Run` [Click here for more instructions](http://cs.uno.edu/~jaime/Courses/2025/devCpp2025Instructions.html)
* `if os == 'Linux or Unix or Mac'`:
* You need to have `GCC` installed:
* Go to the folder having the code(.cpp file).
* Open the terminal, and type : `g++ -o test_prep test-prep.cpp`
* Then run the script by typing : `./test_prep`
<br>
### 7️⃣ Create a new branch :bangbang:
Whenever you are going to make contribution. Please create seperate branch using command and keep your `master` branch clean (i.e. synced with remote branch).
```sh
# It will create a new branch with name Branch_Name and switch to branch Folder_Name
$ git checkout -b Folder_Name
```
Create a seperate branch for contibution and try to use same name of branch as of folder.
To switch to desired branch
```sh
# To switch from one folder to other
$ git checkout Folder_Name
```
To add the changes to the branch. Use
```sh
# To add all files to branch Folder_Name
$ git add .
```
Type in a message relevant for the code reveiwer using
```sh
# This message get associated with all files you have changed
$ git commit -m 'relevant message'
```
<br>
### 8️⃣ Share your work :star_struck:
Now, Push your awesome work to your remote repository using
```sh
# To push your work to your remote repository
$ git push -u origin Folder_Name
```
Then, go to your repository in browser and click on `compare and pull requests`.
Then add a title and description to your pull request that explains your precious effort.
<br>
### 9️⃣ Get Featured in the Contributor's List! 👩💻👨💻
Finally, after your pull request has been merged, add another comment below the PR as follows
```sh
@all-contributors please add @<your_username> for <contributions>
```
In contributions, you need to type `code` if you have contributed to the code, or `documentation` if you
contrubuted for the markdown files.
[Click here for more instructions](https://allcontributors.org/docs/en/bot/usage)
## ⭐ Help Contributing Guides :crown:
We love to have `articles` and `codes` in different languages and `betterment` of existing ones.
Please discuss it with us first by creating new issue.
:tada: :confetti_ball: :smiley: _**Happy Contributing**_ :smiley: :confetti_ball: :tada:
<br>
## ⭐ Language Used:
C++
<br>
## ⭐ Basic Functionalities:
[](https://forthebadge.com)
To schedule the exams for a very short period of time i.e. 1-2 days for the students who begin to study just before the day of the exam and complete syllabus in a very short time.
To schedule the exam time study for students subject wise who start their studies one or two week before the exams so they complete their syllabus of each subject in time.
To schedule the exam time study for students who begin to study quite early I.e. almost a month ago and have enough time to do everything in the syllabus. Also they have no time issue.
<br>
## ⭐ Algorithm used:
[](https://forthebadge.com)
Fractional Knapsack Algorithm: Fractional Knapsack algorithm is used in order to find the chapters to be done on the basis of their weightage so as to maximize marks in limited amount of time.
Job Scheduling Algorithm: This algorithm is implemented so that the user inputs the subjects he/she has to study with the date of exams of the respective subjects and respective priorities. So they get the sequence of subjects as ouput for effective ways of study and managing time.
<br>
## ⭐ Real Life Application:
[](https://forthebadge.com) <br>
A most common problem faced by students during exams is of time management and its utilization.It can help students to effectively manage their time during exams by giving them a sequence in which the should study in order to maximize marks.
<br>
## ⭐ Achievements :cupcake:
<!-- jwoc -->
<div class="container-fluid">
<img class="mx-auto" src="assets/jwoc.jpg">
</div>
<br>
<br>
## 💥 How to Contribute?
[](http://makeapullrequest.com)
[](https://github.com/ellerbrock/open-source-badges/)
<br>
- Take a look at the Existing [Issues](https://github.com/anushka23g/Learning-Made-Easy/issues) or create your own Issues!
- Wait for the Issue to be assigned to you after which you can start working on it.
- Fork the Repo and create a Branch for any Issue that you are working upon.
- Create a Pull Request which will be promptly reviewed and suggestions would be added to improve it.
- Contact [email protected] for more information regarding contributions.