Commit f451444

committed

Added requirements and readme

1 parent 08af154 commit f451444Copy full SHA for f451444

File tree

+26

-1

lines changed

+26

-1

lines changed

Lines changed: 24 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,24 @@`
	`1`	`+# Paint Application`
	`2`	`+Running this Script would open up a Paint application GUI on which the user can draw using the brush tool. The Brush colour and size can be changed, the paint canvas can be saved to the file system aswell.`
	`3`	`+`
	`4`	`+## Setup instructions`
	`5`	`+In order to run this script, you need to have Python and pip installed on your system. After you're done installing Python and pip, run the following command from your terminal to install the requirements from the same folder (directory) of the project.`
	`6`	+```
	`7`	`+pip install -r requirements.txt`
	`8`	+```
	`9`	`+`
	`10`	`+After satisfying all the requirements for the project, Open the terminal in the project folder and run`
	`11`	+```
	`12`	`+python paint.py`
	`13`	+```
	`14`	`+or`
	`15`	+```
	`16`	`+python3 paint.py`
	`17`	+```
	`18`	`+depending upon the python version. Make sure that you are running the command from the same virtual environment in which the required modules are installed.`
	`19`	`+`
	`20`	`+## Output`
	`21`	`+![Sample pic of the Paint Application](https://i.postimg.cc/htft5W7N/paint.png)`
	`22`	`+`
	`23`	`+## Author`
	`24`	`+[Ayush Jain](https://github.com/Ayushjain2205)`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ def __init__(self):`
`10`	`10`	`super().__init__()`
`11`	`11`
`12`	`12`	`# setting application window up`
`13`		`- self.setWindowTitle("Paint with PyQt5")`
	`13`	`+ self.setWindowTitle("Paint Application")`
`14`	`14`	`self.setGeometry(100, 100, 800, 600)`
`15`	`15`
`16`	`16`	`# setting up image object`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+PyQt5`

Comments

(0)