-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
187 lines (144 loc) · 8.59 KB
/
index.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
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="shortcut icon" href="./img/favicon.ico">
<title>Slither</title>
<link href="./css/bootstrap-custom.min.css" rel="stylesheet">
<link href="./css/font-awesome-4.0.3.css" rel="stylesheet">
<link rel="stylesheet" href="./css/highlight.css">
<link href="./css/base.css" rel="stylesheet">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<!-- Collapsed navigation -->
<div class="navbar-header">
<!-- Expander button -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<!-- Main title -->
<a class="navbar-brand" href=".">Slither</a>
</div>
<!-- Expanded navigation -->
<div class="navbar-collapse collapse">
<!-- Main navigation -->
<ul class="nav navbar-nav">
<li class="active">
<a href=".">Home</a>
</li>
<li >
<a href="reference/">Reference</a>
</li>
</ul>
<!-- Search, Navigation and Repo links -->
<ul class="nav navbar-nav navbar-right">
<li>
<a href="#" data-toggle="modal" data-target="#mkdocs_search_modal">
<i class="fa fa-search"></i> Search
</a>
</li>
<li class="disabled">
<a rel="next" >
<i class="fa fa-arrow-left"></i> Previous
</a>
</li>
<li >
<a rel="prev" href="reference/">
Next <i class="fa fa-arrow-right"></i>
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="container">
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
<ul class="nav bs-sidenav">
<li class="main active"><a href="#what-is-slither">What is Slither?</a></li>
<li class="main "><a href="#why-use-slither">Why use Slither?</a></li>
<li class="main "><a href="#how-do-i-install-slither">How do I install Slither?</a></li>
<li><a href="#through-pip">Through pip</a></li>
<li><a href="#manually">Manually</a></li>
<li class="main "><a href="#uh-oh-theres-a-problem">Uh-oh! There's a problem!</a></li>
<li class="main "><a href="#how-can-i-help-with-slither">How can I help with Slither?</a></li>
<li class="main "><a href="#credits">Credits</a></li>
</ul>
</div></div>
<div class="col-md-9" role="main">
<p><img alt="Slither's logo" src="https://cloud.githubusercontent.com/assets/13385064/14028163/82c374ea-f1d1-11e5-84b7-8ebc442b2d70.png" /></p>
<p><a href="https://www.codacy.com/app/stanleybookowl/Slither"><img alt="Codacy Badge" src="https://api.codacy.com/project/badge/grade/6c21312189334c1782a49e152d0f4b78" /></a></p>
<h1 id="what-is-slither">What is Slither?</h1>
<p>Slither is a Python module that uses PyGame to bring Scratch-like features to Python.
<a href="https://scratch.mit.edu">Scratch</a> is a programming language developed by MIT that uses block-based scripts to introduce kids to programming.</p>
<h1 id="why-use-slither">Why use Slither?</h1>
<p>Those just getting started with Python after using Scratch may want to go straight from one GUI to another. Slither allows those people to quickly make simple projects in a matter of minutes, while also learning Python.</p>
<h1 id="how-do-i-install-slither">How do I install Slither?</h1>
<h2 id="through-pip">Through pip</h2>
<p>Run <code>pip install slither</code>.</p>
<h2 id="manually">Manually</h2>
<p>Run <code>python setup.py build</code> and then <code>python setup.py install</code>.<br />
If that doesn't work, run <code>python setup.py bdist_wheel</code>, and then run <code>pip install path</code>, where path is the final path of the .whl file (which should be in dist/). If this fails, install wheel with <code>pip install wheel</code> then retry.<br />
If it still fails, make sure you have <code>setuptools</code> fully updated and properly installed.<br />
Remember to add <code>import slither</code> in your script.<br /></p>
<p>Slither supports both Python 2 and Python 3. Also, note that you must have <a href="http://pygame.org/hifi.html">PyGame</a> installed in order to use Slither.</p>
<h1 id="uh-oh-theres-a-problem">Uh-oh! There's a problem!</h1>
<p>First, check to make sure you've properly installed all of Slither's requirements and Slither.<br />
Next, check your Python program over. Do you have correct syntax and spelling?<br />
Finally, check to see if you have the newest version of Slither.</p>
<p>If you've done all three of those things and it still doesn't work, <a href="https://github.com/PySlither/Slither/issues/new">file an issue</a>.</p>
<h1 id="how-can-i-help-with-slither">How can I help with Slither?</h1>
<p>Check <a href="https://github.com/PySlither/Slither/issues">the issues</a> to see what problems need fixing. Then <a href="https://github.com/PySlither/Slither/compare">make a pull request</a> detailing what you've changed and how it should help. After testing, someone will merge it into the main project.<br />
If you help enough times, Tymewalk will add you as a collaborator.<br />
<strong>WARNING: Abuse of collaborator permissions WILL result in you being removed as a collaborator.</strong><br />
So just be careful with what you do and you'll be fine.</p>
<h1 id="credits">Credits</h1>
<p>Scratch is property of The Lifelong Kindergarten Group. The Slither devs are not affiliated with the LLK, nor do they own Scratch. Slither is in no way associated with, and is not a product of, the LLK.</p></div>
</div>
<footer class="col-md-12">
<hr>
<center>Documentation built with <a href="http://www.mkdocs.org/">MkDocs</a>.</center>
</footer>
<script src="./js/jquery-1.10.2.min.js"></script>
<script src="./js/bootstrap-3.0.3.min.js"></script>
<script src="./js/highlight.pack.js"></script>
<script>var base_url = '.';</script>
<script data-main="./mkdocs/js/search.js" src="./mkdocs/js/require.js"></script>
<script src="./js/base.js"></script>
<div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button>
<h4 class="modal-title" id="exampleModalLabel">Search</h4>
</div>
<div class="modal-body">
<p>
From here you can search these documents. Enter
your search terms below.
</p>
<form role="form">
<div class="form-group">
<input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query">
</div>
</form>
<div id="mkdocs-search-results"></div>
</div>
<div class="modal-footer">
</div>
</div>
</div>
</div>
</body>
</html>