From 6643ccb34aba9c5ee20dc5be5416b49f47c9165e Mon Sep 17 00:00:00 2001 From: Brad Fitzpatrick Date: Tue, 11 Jun 2013 13:14:05 +0200 Subject: [PATCH] Add a BUILDING file, update HACKING, clean some stuff Change-Id: I39c310556cfa7643c3d1aa271acab8ce130e0953 --- BUILDING | 12 ++++++++++++ HACKING | 37 ++++++++++++++++++++++++++++++++++--- camfix.pl => dev/camfix.pl | 0 dev/make-release | 9 +++++++++ 4 files changed, 55 insertions(+), 3 deletions(-) create mode 100644 BUILDING rename camfix.pl => dev/camfix.pl (100%) diff --git a/BUILDING b/BUILDING new file mode 100644 index 000000000..6ae80387e --- /dev/null +++ b/BUILDING @@ -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. diff --git a/HACKING b/HACKING index a5413400d..2a1a19e26 100644 --- a/HACKING +++ b/HACKING @@ -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. diff --git a/camfix.pl b/dev/camfix.pl similarity index 100% rename from camfix.pl rename to dev/camfix.pl diff --git a/dev/make-release b/dev/make-release index e184aa951..c578e113c 100755 --- a/dev/make-release +++ b/dev/make-release @@ -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"; }