Skip to content

Commit 718efef

Browse files
Merge pull request #29 from arifulhaqueuc/feature/update-readme-v3
Update readme to v3
2 parents d322d84 + 5fd1e86 commit 718efef

File tree

1 file changed

+48
-45
lines changed

1 file changed

+48
-45
lines changed

README.md

Lines changed: 48 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,44 @@
1-
### Update Center / Repository Update Info <img src="https://user-images.githubusercontent.com/20999114/35537819-a71d5fc4-0519-11e8-9d1f-489ca7ed6822.gif" height="30" width="40">
2-
Time: Jan 30 01:00 AM EST
1+
<img src="https://user-images.githubusercontent.com/20999114/35537819-a71d5fc4-0519-11e8-9d1f-489ca7ed6822.gif" height="30" width="40"> Update Center
2+
====
3+
Last Update Info
4+
<br />Time: Jan 31 01:00 AM EST
35
<br />Update Impact: Major
46

57
```diff
68
+ This repo is under active development at this time,
79
- so, frequent and random updates
810
+ are very likely to happen. Followers are requested to update
9-
+ their local repository every every other day. Thank you.
11+
+ their local repository as frequent as possible. Thank you.
1012
```
1113

12-
### Python-Multithreading-Example
13-
A collection of Python Scripts.
1414

1515

16-
### Background
16+
:couple: Audience Insights
17+
====
18+
#### Target Audience
19+
Developers who already have a good understand of Python programming (version 2.x in particular for this repo) and would like to know in details about Python's Threading module.
1720

18-
As we all know, in general, running multiple threads simulteneously is equivalent to running several programs at the same time. In such case, threading in Python is a very popular process to attain concurrency and parallelism. Using threading module in a Python program gives us several key advatages such as sharing same data space and operating on light-weight process in order to avoid unnecessary memory overhead.
21+
#### Purposes
22+
This repository helps us understand different usage of Python's threading module with various requirements.
23+
24+
#### What to expect
25+
After practicing in all given scripts at least couple of time would help Python's developers having a very solid understanding of Python's threading module, such as, how to write multithreaded Python appliation and/or scripts.
26+
27+
#### Pre-requisites / Know Before You Go
28+
- Basic knowledge of Python Multithreading module and its built-in functions
29+
- Good Knowledge of OOP
30+
- Good Knowledge of args, and kwargs
1931

20-
This repository helps us understand usage of Python's threading module in different programs with various requirements.
2132

33+
:green_book: About the Project
34+
===
35+
#### Repository Type
36+
This repo is not a complete application or project, rather it's a collection of individual scripts.
37+
38+
#### Knowledge Base
39+
As we all know, in general, running multiple threads simulteneously is equivalent to running several programs at the same time. In such case, threading in Python is a very popular process to attain concurrency and parallelism. Using threading module in a Python program gives us several key advatages such as sharing same data space and operating on light-weight process in order to avoid unnecessary memory overhead.
2240

23-
### Project Overview
41+
#### Birds Eye View
2442
| | |
2543
| --- | --- |
2644
| Repo Type | Script Type |
@@ -30,15 +48,9 @@ This repository helps us understand usage of Python's threading module in differ
3048
| License Type | MIT |
3149

3250

33-
### Project Description
34-
51+
#### Functional Description
3552
All the following files are avilable in the 'app' directory.
36-
37-
![#f03c15](https://placehold.it/15/f03c15/000000?text=+) *Please note that this description section may not be fully
38-
updated as of today as I update this section once a week. You might find more scripts in the acctual application directory*. All scripts have short in-script description on the function of the program.
39-
40-
41-
All scripts/examples used Python's threading module.
53+
<br /> *Please note that this description section may not be fully updated as of today as I update this section once a week. You might find more scripts in the acctual application directory. Each script has a concise in-script description of the program.*
4254

4355
| File Name | Difficulty Devel | Description |
4456
| --- | --- | --- |
@@ -58,39 +70,30 @@ All scripts/examples used Python's threading module.
5870
| script_11 | Intermediate | This program tries to access the values of args and kwargs. |
5971
| script_12 | TBD | TBD |
6072

61-
62-
63-
### Technical Description / Primary Technologies or concepts Used
73+
### Technical Description
74+
I have used the following primary Technologies/concepts
6475
- Python 2.7
6576
- Multithreading
6677

67-
68-
### How to Run
78+
### How to run
6979
- clone the repo
70-
- install the requirements from requirements.txt file
71-
- go to the app directory
72-
- run individual file
73-
74-
75-
### Pre-requisites / Know Before You Go
76-
- Basic knowledge of Python (version 2.x) is required.
77-
- Should have basic understanding of Python Multithreading, its importance and usages
78-
79-
80-
### Application Functionalities
81-
Becasue this repo is not a project type, in fact it is a collection of several discrete scripts, so their functions are different from one another. Please take a look at the project description to know more about the functionalities of the programs.
82-
83-
84-
### Future Direction / Areas of Improvement
85-
Many more programs to come in each week until the above mentioned expected deadline.
86-
87-
88-
### Support / Found a bug?
89-
Here are the options
80+
- go to the *scripts* directory
81+
- run individual file through terminal as follows
82+
```
83+
python file_name.py
84+
```
85+
86+
:computer: Support & Disclaimer
87+
===
88+
### Support
89+
Found a bug??
90+
<br />Here are the options
9091
- Please file an issue with detailed description.
9192
- If you know a possible solution, please create a new brnach, update the code and then submit pull request.
9293
- If you would like to reach out to me directly with any question, email me at ariful.haque.uc@gmail.com
93-
94-
95-
### General Disclaimer
94+
95+
Interester in Collaboration and Contribution??
96+
<br /> I am open to except any relevant collaboration suggestion from developers. Feel free to reach out to me in email.
97+
98+
### General Disclaimer
9699
This is my personal repo and not an official product of any company. If you would like to use this code, please keep it in your mind that, although I have tried to make it as error-free as possible, there's no warranty of a 100% bug free application.

0 commit comments

Comments
 (0)