Skip to content
This repository was archived by the owner on Jun 7, 2023. It is now read-only.

Commit b696bbe

Browse files
committed
Update readme with some development notes
1 parent fa6aba5 commit b696bbe

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,19 @@ installation every so often. If you are new to using Python on windows I recomm
6666
link on `Using Python with Windows <https://docs.python.org/3.4/using/windows.html>`_
6767

6868

69+
Developing and Hacking
70+
----------------------
71+
72+
So, you would like to help out with developing the Runestone Components. What do you need to know?
73+
74+
1. Make a Fork of this repository.
75+
2. Setup your environment on your development machine
76+
1. Make a virtual environment for testing and working I recommend pyvenv-3.4 as it is baked in to Python 3.4 and higher.
77+
2. Rather than following the instructions above for installing runestone simply run ``pip install . `` from the top level runestone directory. This will install all of the required prerequisites and setup the runestone install as a link to the development directory.
78+
79+
3. When you have some changes to share, make a Pull Request.
80+
81+
6982
Notes for more Advanced Users
7083
-----------------------------
7184

0 commit comments

Comments
 (0)