-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathReadme.html
141 lines (136 loc) · 6.17 KB
/
Readme.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<!--<link rel="stylesheet" href="style.css" />-->
<title>Readme</title>
</head>
<body>
<h1>
Onix-Zeta
</h1>
<p style="font-size: 25px;">
Onix-Zeta is a retro type arcade style online fighting game. It is a classic fighting game featuring the epic Ryu vs
Sagat fight. This is a multiplayer game interface where two users can play together.<br>
<img src="game_pics/onix1.png" style="width: 500px; height: 500px; margin-top: 20px;"> <img src="game_pics/onix2.png"
style="width: 500px; height: 500px; margin-top: 20px;"> <img src="game_pics/onix3.png"
style="width: 500px; height: 500px; margin-top: 20px;">
</p>
<h1>How To Play</h1>
<p style="font-size: 25px;">
<ul>
<li style="font-size: 25px;">If single user is playing then just click the simulate button to enjoy the game. After
getting winner click reset button to reset the score of the fighters.</li>
<li style="font-size: 25px;">If multi user is playing then use keyboard buttons to play the game. 'Q' and 'A' keys
are used for player 1 to fight. Similarly, 'P' and 'L' keys are used for player 2 to fight.</li>
</ul>
</p>
<h1>How To Contribute</h1>
<p style="font-size: 25px;">
<ul>
<li style="font-size: 25px;">
Search for <strong>"subhamgcon / Onix-Zeta"</strong> in GitHub.
</li>
<li style="font-size: 25px;">
Click on <strong>Fork</strong> button to create a copy repository in your GitHub profile.
</li>
<li style="font-size: 25px;">
A new repository has been created in your profile. Now before cloning it, first update the branch by clicking
<strong>Sync Fork</strong> button so that if any changes has been made will get up to date in your forked
repository.
</li>
<li style="font-size: 25px;">
To clone your forked repository, first download git bash in your system. The link to download git bash: <a
href="https://git-scm.com/downloads" target="_blank">https://git-scm.com/downloads</a>
</li>
<li style="font-size: 25px;">
After installation process you need to config your git with GitHub. Open the git bash terminal and type the
following commands:
<ul>
<li><strong>$ git config --global user.name "User Name"</strong> to set up user name.</li>
<li><strong>$ git config --global user.email "User Email"</strong> to set up user email.</li>
</ul>
</li>
</li>
<li style="font-size: 25px;">
Now your git is configured with GitHub. You are all set to commit changes from your system to reflect on GitHub.
</li>
<li style="font-size: 25px;">
First, clone your forked repository in your system by typing command in git bash terminal:
<ul>
<li>If you want to clone it in a specific directory then type <strong>cd Directory Name</strong>. It will open
the directory in your terminal. Any changes you make will directly reflect in that directory.</li>
<li>Then in that directory clone your forked repo by typing: <strong>$ git clone Project URL</strong></li>
</ul>
</li>
<li style="font-size: 25px;">
Your forked repository is now cloned to your system in that respective directory. Now make the changes required
from your system.
</li>
<li style="font-size: 25px;">
Now you need to commit the changes so that it reflects in your GitHub. Type the following commands in your git
bash terminal:
<ul>
<li><strong>$ git status</strong> to check your status which files are staged to commit.</li>
<li><strong>$ git add .</strong> to stage the files for commit.</li>
<li><strong>$ git status</strong> used again to cross check if changed files are staged or not.</li>
<li><strong>$ git commit -m "short message"</strong> to commit the changes in your forked repository.</li>
<li><strong>$ git checkout -b my-branch-name</strong> to create a branch so as to avoid branch conflict while
pushing commits.</li>
<li><strong>$ git push origin my-branch-name</strong> to push the committed files in the new branch created.
</li>
<li>Now, the changes has been pushed successfully to your forked repository in a new branch to avoid conflicts.
</li>
<li>Visit your forked repository. There will be an option of <strong>Compare and Pull Request</strong> at the
top. Click that button and proceed to create pull request for asking the maintainer to review changes you
made. After all this process, your pull request is opened which you can view from the main repository.</li>
</ul>
</li>
<li style="font-size: 25px;">
This way you can contribute to this project by following the above steps.
</li>
</ul>
</p>
<h1>Guidelines</h1>
<p style="font-size: 25px;">
<ul>
<li style="font-size: 25px;">
Pull requests that are automated e.g. scripted opening pull requests to remove whitespace / fix typos / optimize
images.
</li>
<li style="font-size: 25px;">
Pull requests that are disruptive e.g. taking someone else's branch/commits and making a pull request.
</li>
<li style="font-size: 25px;">
Pull requests that are regarded by a project maintainer as a hindrance vs. helping.
</li>
<li style="font-size: 25px;">
Last but not least, one pull request to fix a typo is fine, but 5 pull requests to remove a stray whitespace is
not.
</li>
</ul>
</p>
<h1>Contribution Rules</h1>
<p style="font-size: 25px;">
<ul>
<li style="font-size: 25px;">
You are allowed to make pull requests that break the rules. We just merge it :)
</li>
<li style="font-size: 25px;">
Do NOT add any build steps e.g npm install (we want to keep this a simple static site)
</li>
<li style="font-size: 25px;">
Do NOT remove others content.
</li>
<li style="font-size: 25px;">
Styling/code can be pretty, ugly or stupid, big or small as long as it works.
</li>
</ul>
</p>
<h1>
<center>Thank You!!</center>
</h1>
<script src="script.js"></script>
</body>
</html>