Merge ~mpontillo/uvtool:add-hacking-md into uvtool:master

Proposed by Mike Pontillo
Status: Needs review
Proposed branch: ~mpontillo/uvtool:add-hacking-md
Merge into: uvtool:master
Diff against target: 32 lines (+26/-0)
1 file modified
HACKING.md (+26/-0)
Reviewer Review Type Date Requested Status
uvtool development Pending
Review via email: mp+314184@code.launchpad.net

Commit message

Add initial HACKING.md file.

Description of the change

Here's a version of `HACKING.md` that I think we both agree on. My other MP still stands and has been rebased to build on top of this.

To post a comment you must log in.

Unmerged commits

831d750... by Mike Pontillo on 2017-01-05

Add initial HACKING.md file.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1diff --git a/HACKING.md b/HACKING.md
2new file mode 100644
3index 0000000..d484b53
4--- /dev/null
5+++ b/HACKING.md
6@@ -0,0 +1,26 @@
7+Quick Start
8+===========
9+
10+To get started, first install the dependencies, such as:
11+
12+ sudo apt-get install -uy libvirt-bin python-libvirt python-simplestreams \
13+ python-lxml python-pyinotify python-yaml distro-info \
14+ cloud-image-utils qemu-utils ubuntu-cloudimage-keyring socat python \
15+ qemu-kvm cpu-checker
16+
17+After installing the dependencies, the only requirement for working on
18+`uvtool` is that the `PYTHONPATH` includes its source. Minimally, you can
19+test `uvtool` by doing something like this from the sandbox root:
20+
21+ PYTHONPATH=. bin/...
22+
23+
24+Development Platform and Dependencies
25+=====================================
26+
27+While `uvtool` is indended to be a pure Python project, it is still tightly
28+coupled to Ubuntu. (Patches will be accepted to make it more "Pythonic".)
29+
30+That said, the current primary development platform for `uvtool` is the latest
31+LTS release of Ubuntu. Secondarily, it may be tested on the latest
32+development release.

Subscribers

People subscribed via source and target branches