Skip to content

Commit 338ec22

Browse files
authored
Update README.md
1 parent 7d56fce commit 338ec22

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,46 @@
1212
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](http://makeapullrequest.com)
1313

1414

15+
## Installation
16+
17+
Install using `pip` from PyPI
18+
19+
```bash
20+
pip install coderunner
21+
```
22+
23+
or directly from GitHub if you cannot wait to test new features
24+
25+
```bash
26+
pip install git+https://github.com/codeclassroom/CodeRunner.git
27+
```
1528
## Usage
1629

17-
- Install `coderunner`.
30+
```python
1831

19-
`pip install coderunner`
32+
import coderunner
33+
34+
program_name = "path-to/test_python.py"
35+
language = "Python"
36+
output = "path-to/output.txt"
37+
Input = "path-to/input.txt"
38+
39+
# use this if you have a standard input to Program
40+
r = coderunner.Run(program_name, language, output, Input)
41+
42+
# otherwise
43+
r = coderunner.Run(program_name, language, output)
44+
45+
# if not using file paths
46+
r = coderunner.Run("Hello, World", language, "Hello, World", path=False)
47+
```
2048

2149
## Documentation
2250

2351
> [CodeRunner Documentation](https://coderunner.readthedocs.io/en/latest/)
2452
2553

26-
## Testing
54+
## Development
2755

2856
##### Prerequisites
2957
- Python 3.6+
@@ -51,6 +79,10 @@ flake8 coderunner --max-line-length=88 --ignore=F401
5179
pylint coderunner --disable=bad-continuation,invalid-name,too-many-instance-attributes
5280
```
5381

82+
## Changelog
83+
84+
Changelog can be found in [Releases](https://github.com/codeclassroom/CodeRunner/releases)
85+
5486

5587
## Author
5688

0 commit comments

Comments
 (0)