Skip to content

Commit 5b37415

Browse files
committed
Cleanup README
1 parent 2310b10 commit 5b37415

File tree

5 files changed

+16
-16
lines changed

5 files changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
Online Python 3.6 Programming with Live Pylint Syntax Checking!
66
<br>
77
<i>
8-
GIF below is in Python 2.7. <b>Demo: http://pythonbuddy.com </b>
8+
<b>Demo: http://pythonbuddy.com </b>
99
</i>
1010
<br>
11-
![](gifs/pybuddy.gif)
11+
![](gifs/demo.gif)
1212

1313
### Usage
1414
1) Fetch from repo:
@@ -49,7 +49,7 @@ Online Python 3.6 Programming with Live Pylint Syntax Checking!
4949
</ul>
5050
</li>
5151

52-
![](gifs/pybuddy2.gif)
52+
![](gifs/demo2.gif)
5353

5454
<br>
5555
<li>Python Execution
@@ -59,21 +59,21 @@ Online Python 3.6 Programming with Live Pylint Syntax Checking!
5959
</ul>
6060
</li>
6161

62-
![](gifs/pybuddy3.gif)
62+
![](gifs/demo3.gif)
6363

6464
<br>
6565
<li>Live Error Table with Additional Help Suggestions</li>
6666

67-
![](gifs/pybuddy4.gif)
67+
![](gifs/demo4.gif)
6868

6969
<br>
7070

7171
### Secure (Sandboxed) Version using Docker
72-
Please check out [PythonBuddySandboxed](https://github.com/ethanchewy/PythonBuddySandboxed) for a fully working web implementation which uses a dockerized version of PythonBuddy called [PythonBuddySandbox](https://github.com/christophetd/docker-python-sandbox).
72+
Please check out [PythonBuddySandboxed](https://github.com/ethanchewy/PythonBuddySandboxed) for a fully working web implementation which uses a dockerized version of PythonBuddy called [PythonBuddySandbox](https://github.com/christophetd/docker-python-sandbox).
7373

7474
This builds off of christophetd's [docker-python-sandbox](https://github.com/christophetd/docker-python-sandbox) and just modifies it so that it runs pylint in the background and processes the pylint messages on the client side.
7575

76-
To see how he implements it on the web side, please check out [https://github.com/christophetd/code-execution-api-demo](https://github.com/christophetd/code-execution-api-demo)
76+
To see how he implements it on the web side, please check out [https://github.com/christophetd/code-execution-api-demo](https://github.com/christophetd/code-execution-api-demo)
7777

7878
This is still in alpha stage so there might be some bugs. If you want to implement this please check the 4 links above since documentation is a WIP.
7979

@@ -114,12 +114,12 @@ I'm currently working on this over here (for edx specifically): https://github.c
114114
```
115115

116116
I want the code to actually compile and run in a certain way?<br>
117-
To run PythonBuddy securely, you can check out my implementation of PythonBuddy with Docker and Node.js: https://github.com/ethanchewy/PythonBuddy#secure-sandboxed-version-using-docker. Basically, it dockerizes each user session (similar to creating a virtual machine for each user) and destroys it if it uses too much memory or runs malicious code.
117+
To run PythonBuddy securely, you can check out my implementation of PythonBuddy with Docker and Node.js: https://github.com/ethanchewy/PythonBuddy#secure-sandboxed-version-using-docker. Basically, it dockerizes each user session (similar to creating a virtual machine for each user) and destroys it if it uses too much memory or runs malicious code.
118118
<br>
119-
If you want to actually execute the python in a restricted fashion at my Restricted Python branch: https://github.com/ethanchewy/PythonBuddy/tree/restrictedpython.
119+
If you want to actually execute the python in a restricted fashion at my Restricted Python branch: https://github.com/ethanchewy/PythonBuddy/tree/restrictedpython.
120120

121121
How do I run my own server?
122-
Regular: https://github.com/ethanchewy/OnlinePythonLinterSyntaxChecker/wiki
122+
Regular: https://github.com/ethanchewy/OnlinePythonLinterSyntaxChecker/wiki
123123
<br>
124124
Sandboxed: https://github.com/ethanchewy/PythonBuddy/wiki/Running-Sandboxed-PythonBuddy
125125

@@ -132,17 +132,17 @@ This was made by Ethan Chiu as a research project under the guidance of Wellesle
132132
### Donations:
133133
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](http://paypal.me/Ethan302)
134134

135-
I started working on this in 2016 after seeing no one had addressed the issue of reducing the high attrition rate of beginning Python programmers due to the difficulties of setting up their programming environment.
135+
I started working on this in 2016 after seeing no one had addressed the issue of reducing the high attrition rate of beginning Python programmers due to the difficulties of setting up their programming environment.
136136

137-
So, ever since then, I've always been trying to improve PythonBuddy such as security and scalabitliy. Thus, I have dedicated as much as my free time into this project.
137+
So, ever since then, I've always been trying to improve PythonBuddy such as security and scalabitliy. Thus, I have dedicated as much as my free time into this project.
138138

139-
Since 2016, it's cost more than $250 per year to run and deploy the demo site excluding development costs.
139+
Since 2016, it's cost more than $250 per year to run and deploy the demo site excluding development costs.
140140

141-
Before college, I've been able to save money from various jobs. Now that I am in college, I have to pay a hefty tuition, housing, food, etc so it's much harder to sustain PythonBuddy even with a part-time job.
141+
Before college, I've been able to save money from various jobs. Now that I am in college, I have to pay a hefty tuition, housing, food, etc so it's much harder to sustain PythonBuddy even with a part-time job.
142142

143-
My goal is to keep the demo site PythonBuddy running since more than 4,000 users use it daily. All donations will go towards PythonBuddy and any excess will be used to increase the specs of the PythonBuddy demo server.
143+
My goal is to keep the demo site PythonBuddy running since more than 4,000 users use it daily. All donations will go towards PythonBuddy and any excess will be used to increase the specs of the PythonBuddy demo server.
144144

145-
Any donation would be greatly appreciated.
145+
Any donation would be greatly appreciated.
146146

147147
<b> No donation is too small. </b> A dollar goes a long way :)
148148

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)