Skip to content

Commit

Permalink
Update documentation with new features.
Browse files Browse the repository at this point in the history
  • Loading branch information
donkirkby committed Jan 26, 2017
1 parent 51b1e17 commit 8c9db32
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 10 deletions.
28 changes: 22 additions & 6 deletions README.md
Expand Up @@ -6,6 +6,11 @@ live-py-plugin

Live coding in Python implemented as an Eclipse plugin or an Emacs minor mode.

[Build Status]: https://travis-ci.org/donkirkby/live-py-plugin.svg?branch=master
[travis]: https://travis-ci.org/live-py-plugin
[Code Coverage]: https://codecov.io/github/donkirkby/live-py-plugin/coverage.svg?branch=master
[codecov]: https://codecov.io/github/donkirkby/live-py-plugin?branch=master

To see how to use it, watch the [demo video][video] or read the
[getting started page][starting]. You might also find some useful examples in
the [tools folder][tools]. To learn more, read about [how it works][how].
Expand All @@ -18,10 +23,6 @@ helping in all kinds of ways.

If you like this project, check out some of my [other projects][projects].

[Build Status]: https://travis-ci.org/donkirkby/live-py-plugin.svg?branch=master
[travis]: https://travis-ci.org/live-py-plugin
[Code Coverage]: https://codecov.io/github/donkirkby/live-py-plugin/coverage.svg?branch=master
[codecov]: https://codecov.io/github/donkirkby/live-py-plugin?branch=master
[how]: http://donkirkby.github.io/live-py-plugin/howitworks
[screenshot]: http://donkirkby.github.com/live-py-plugin/images/demo_star.png
[akaihola]: https://github.com/akaihola
Expand All @@ -41,6 +42,15 @@ Installing the Eclipse plugin
your code.
6. To try the turtle graphics features, open the Live Coding menu, and choose
Start Live Turtle. The panel on the right shows the turtle graphics display.
7. You can also use another script or a unit test to drive your live code.
Run your driver script or unit test as usual in Eclipse, then click on the
small arrow next to the big live coding arrow in the toolbar. You should see
all the different Python and unit test launches listed there. Click on the
one you want, and it will call the live version of your code. To run a
single unit test method, open the test file, and type
<kbd>Ctrl</kbd>+<kbd>F9</kbd>, then choose the test method you want to run.
Edit your run configurations to give the new configuration a meaningful name,
then choose it from the live coding arrow's menu.

If you don't want to use the Eclipse marketplace, you can also install from the
[update site][update].
Expand Down Expand Up @@ -69,6 +79,11 @@ section, but the next section gives instructions for installing without MELPA.
6. Open any Python file, and activate live-py-mode with `M-x live-py-mode`.
You should see an extra window on the right that shows the results of running
your code.
7. Type `C-h m` and scroll down to the **Live-Py** section to see all the
advanced features that let you run other versions of Python or drive your
live coding from another script or a unit test.

[melpa]: https://melpa.org/#/getting-started

Installing the Emacs mode without MELPA
---------------------------------------
Expand All @@ -93,8 +108,9 @@ Installing the Emacs mode without MELPA
6. Open any Python file, and activate live-py-mode with `M-x live-py-mode`.
You should see an extra window on the right that shows the results of running
your code.

[melpa]: https://melpa.org/#/getting-started
7. Type `C-h m` and scroll down to the **Live-Py** section to see all the
advanced features that let you run other versions of Python or drive your
live coding from another script or a unit test.

Uninstalling the Emacs mode
---------------------------
Expand Down
23 changes: 19 additions & 4 deletions docs/index.md
Expand Up @@ -31,8 +31,17 @@ Installing the Eclipse plugin
5. Open any Python file, and from the Live Coding menu, choose Start Live Coding.
You should see an extra panel on the right that shows the results of running
your code.
6. To try the turtle graphics features, open the Window menu, and choose
Show View: Other.... Then under PyDev, click Live Coding Canvas and click OK.
6. To try the turtle graphics features, open the Live Coding menu, and choose
Start Live Turtle. The panel on the right shows the turtle graphics display.
7. You can also use another script or a unit test to drive your live code.
Run your driver script or unit test as usual in Eclipse, then click on the
small arrow next to the big live coding arrow in the toolbar. You should see
all the different Python and unit test launches listed there. Click on the
one you want, and it will call the live version of your code. To run a
single unit test method, open the test file, and type
<kbd>Ctrl</kbd>+<kbd>F9</kbd>, then choose the test method you want to run.
Edit your run configurations to give the new configuration a meaningful name,
then choose it from the live coding arrow's menu.

If you don't want to use the Eclipse marketplace, you can also install from the
[update site][update].
Expand Down Expand Up @@ -61,6 +70,11 @@ section, but the next section gives instructions for installing without MELPA.
6. Open any Python file, and activate live-py-mode with `M-x live-py-mode`.
You should see an extra window on the right that shows the results of running
your code.
7. Type `C-h m` and scroll down to the **Live-Py** section to see all the
advanced features that let you run other versions of Python or drive your
live coding from another script or a unit test.

[melpa]: https://melpa.org/#/getting-started

Installing the Emacs mode without MELPA
---------------------------------------
Expand All @@ -85,8 +99,9 @@ Installing the Emacs mode without MELPA
6. Open any Python file, and activate live-py-mode with `M-x live-py-mode`.
You should see an extra window on the right that shows the results of running
your code.

[melpa]: https://melpa.org/#/getting-started
7. Type `C-h m` and scroll down to the **Live-Py** section to see all the
advanced features that let you run other versions of Python or drive your
live coding from another script or a unit test.

Uninstalling the Emacs mode
---------------------------
Expand Down

0 comments on commit 8c9db32

Please sign in to comment.