Add a BUILDING file, update HACKING, clean some stuff

Change-Id: I39c310556cfa7643c3d1aa271acab8ce130e0953
This commit is contained in:
Brad Fitzpatrick 2013-06-11 13:14:05 +02:00
parent bcb2a0e4ff
commit 6643ccb34a
4 changed files with 55 additions and 3 deletions

12
BUILDING Normal file
View File

@ -0,0 +1,12 @@
To build Camlistore:
1) Install Go 1.1 or later.
2) cd to the root of the Camlistore source (where this file is)
3) Run:
$ go run make.go
4) The compiled binaries should now be in the "bin" subdirectory:
camlistored (the server), camget, camput, and camtool.

37
HACKING
View File

@ -1,12 +1,43 @@
Camlistore contributors regularly use Linux and OS X, and both are
100% supported.
Developing on Windows is sometimes broken, but should work. Let us
know if we broke something, or we accidentally depend on some
Unix-specific build tool somewhere.
See http://camlistore.org/docs/contributing for information
on how to contribute to the project and submit patches.
On Debian, to get started:
See architecture docs: https://camlistore.org/docs/
You can view docs for Camlistore packages with local godoc, or
godoc.org.
It's recommended you use git to fetch the source code, rather than
hack from a Camlistore release's zip file:
$ git clone https://camlistore.org/r/p/camlistore
(We use github for distribution and collaboration with some people,
but the Gerrit git server & code review system is the main repo.)
After cloning it, move the top-level directory to be named
"camlistore.org" under your $GOPATH/src. (e.g. if your $GOPATH is
$HOME, put the Camlistore git repo at $HOME/src/camlistore.org) This
isn't required for normal users, but is assumed for people hacking on
Camlistore.
On Debian/Ubuntu, some deps to get started:
$ sudo apt-get install libsqlite3-dev sqlite3 pkg-config git make
Then we use the following scripts to run a hermetic, self-contained
environment independent (with its own config files & storage space):
$ sudo apt-get install libsqlite3-dev sqlite3 pkg-config subversion git make
$ ./dev-server
$ ./dev-camput
$ ./dev-camget
... etc.
etc
Please update this file as appropriate.

View File

@ -33,6 +33,15 @@ foreach my $d (qw{
website
clients/chrome
lib
old
dev-appengine
dev-camget
dev-cammount
dev-camput
dev-camtool
dev-db
dev-pass-camput
dev-server
}) {
system("git", "rm", "-r", $d) and die "Failed to git rm -r $d";
}