Skip to content

Commit 81ba2d1

Browse files
authored
Merge pull request #1 from tejan-singh/main
Update README.md
2 parents 974db38 + 78b8ce4 commit 81ba2d1

File tree

1 file changed

+117
-1
lines changed

1 file changed

+117
-1
lines changed

README.md

Lines changed: 117 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,117 @@
1-
# hacking-tools-scripts
1+
# Hacking-Tools-Scripts
2+
[![forthebadge](https://forthebadge.com/images/badges/built-by-developers.svg)](https://forthebadge.com)
3+
[![forthebadge](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com)
4+
5+
## Autumn of Open Source AOSS 2020
6+
<p align="center">
7+
<a href="https://sanscript.tech/">
8+
<img src="https://avatars3.githubusercontent.com/t/4187434?s=280&v=4" alt="Logo">
9+
</a>
10+
11+
12+
## Brief: 🎏
13+
Collection of awesome **Python** scripts and tools from basic to advance with hacking task scripts. Contributing to this project will help you learn open source development and collaborations.
14+
15+
16+
## Overview 🎃
17+
This project is mainly ensured to build in an open source community to help the people of our country grow and develop themselves.
18+
19+
20+
### This project is under AOS 2020 (Autumn open source program) under Sanscript, India .🎉🎊
21+
22+
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
23+
24+
25+
26+
## How to start ? 🎪
27+
28+
29+
#### If you don't have git on your machine, [install it](https://help.github.com/articles/set-up-git/).
30+
31+
## Fork this repository 🚀
32+
33+
Fork this repository by clicking on the fork button on the top of this page.
34+
This will create a copy of this repository in your account.
35+
36+
## Clone the repository 🏁
37+
38+
Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the _copy to clipboard_ icon.
39+
40+
Open a terminal and run the following git command:
41+
42+
```
43+
git clone "url you just copied"
44+
```
45+
46+
where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.
47+
48+
49+
For example:
50+
51+
```
52+
git clone https://github.com/sanscript-tech/hacking-tools-scripts
53+
```
54+
55+
## Tech stacks used 🛴
56+
57+
Python
58+
59+
60+
## Create a branch ⚓
61+
62+
Change to the repository directory on your computer (if you are not already there):
63+
64+
```
65+
cd (filename)
66+
```
67+
68+
Now create a branch using the `git checkout` command:
69+
70+
```
71+
git checkout -b your-new-branch-name
72+
```
73+
74+
For example:
75+
76+
```
77+
git checkout -b dev_username
78+
```
79+
80+
## Make necessary changes and commit those changes 🚏
81+
82+
Do the necessary changes.
83+
84+
If you go to the project directory and execute the command `git status`, you'll see there are changes.
85+
86+
Add those changes to the branch you just created using the `git add` command:
87+
88+
```
89+
git add .
90+
```
91+
92+
Now commit those changes using the `git commit` command:
93+
94+
```
95+
git commit -m "(Add your message here)"
96+
```
97+
98+
replacing `<Add your message here>` with your message.
99+
100+
## Push changes to GitHub 🪂
101+
102+
Push your changes using the command `git push`:
103+
104+
```
105+
git push origin <branch-name>
106+
```
107+
108+
replacing `<branch-name>` with the name of the branch you created earlier.
109+
110+
## Submit your changes for review 🚩
111+
112+
If you go to your repository on GitHub, you'll see a `Compare & pull request` button. Click on that button.
113+
114+
Now submit the pull request.
115+
116+
Soon we will be merging all your changes into the master branch of this project. You will get a notification email once the changes have been merged.
117+

0 commit comments

Comments
 (0)