From: Simon Josefsson <simon@josefsson.org>
Date: Tue, 5 May 2009 14:42:17 +0000 (+0000)
Subject: Fix instructions.
X-Git-Tag: yubikey-personalisation_1.3.5-1~4^2~170
X-Git-Url: https://err.no/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f981dabe6e39548e52ab72cae3829e48640147fa;p=yubikey-personalization.old

Fix instructions.
---

diff --git a/Makefile.am b/Makefile.am
index dc4dc03..c56cfaf 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -66,11 +66,20 @@ TESTS = $(ctests)
 ChangeLog:
 	svn2cl
 
+PROJECT=yubikey-personalization
+
 release:
 	rm -f ChangeLog
 	make ChangeLog distcheck
-	svn copy https://$(PACKAGE).googlecode.com/svn/trunk/ \
-	 https://$(PACKAGE).googlecode.com/svn/tags/$(PACKAGE)-$(VERSION) \
+	gpg -b $(PACKAGE)-$(VERSION).tar.gz
+	gpg --verify $(PACKAGE)-$(VERSION).tar.gz.sig
+	svn copy https://$(PROJECT).googlecode.com/svn/trunk/ \
+	 https://$(PROJECT).googlecode.com/svn/tags/$(PACKAGE)-$(VERSION) \
 	 -m "Tagging the $(VERSION) release of the $(PACKAGE) project."
-	googlecode_upload.py -s "Yubico Key personalization library v$(VERSION)." \
-	 -p $(PACKAGE) -u levitte $(PACKAGE)-$(VERSION).tar.gz 
+	googlecode_upload.py -s "OpenPGP signature for $(PACKAGE) $(VERSION)." \
+	 -p $(PROJECT) -u simon75j $(PACKAGE)-$(VERSION).tar.gz.sig
+	googlecode_upload.py -s "$(PACKAGE) $(VERSION)" \
+	 -p $(PROJECT) -u simon75j $(PACKAGE)-$(VERSION).tar.gz 
+	cp README ../wiki-$(PROJECT)/ReadMe.wiki && \
+		cd ../wiki-$(PROJECT) && \
+		svn commit -m Sync. ReadMe.wiki
diff --git a/README b/README
index 32f65a6..cf390ea 100644
--- a/README
+++ b/README
@@ -1,4 +1,12 @@
-=Dependencies=
+#summary Installation of the Yubikey Personalization package
+#labels Featured,Phase-Deploy
+
+= Yubikey Personalization =
+
+The YubiKey Personalization package contains a library and command
+line tool used to personalize (i.e., set a AES key) YubiKeys.
+
+== Dependencies ==
 
 Yubico-c-client is needed, see http://code.google.com/p/yubico-c/
 
@@ -9,9 +17,51 @@ are example for a few flavors:
   (Debian) apt-get install libusb-dev
   (Fedora) yum install libusb-devel
 
+== Building from SVN ==
+
+Skip to the next section if you are using an official packaged
+version.
+
+You may check out the sources using SVN with the following command:
+
+{{{
+  svn checkout http://yubikey-personalization.googlecode.com/svn/trunk/ yubikey-personalization
+}}}
+
+This will create a directory 'yubikey-personalization'.  Enter the directory:
+
+{{{
+  cd yubikey-personalization
+}}}
+
+Autoconf, automake and libtool must be installed.
+
+Generate the build system using:
+
+{{{
+  autoreconf --install
+}}}
+
+== Building ==
+
+You will need to have libyubikey (yubikey.h, libyubikey.so) and libusb
+(usb.h, libusb.so) installed.  Get the libyubikey library from:
+
+http://code.google.com/p/yubico-c/
+
+The build system uses Autoconf, to set up the build system run:
+
+{{{
+  ./configure
+}}}
+
+Then build the code, run the self-test and install the binaries:
+
+{{{
+  make check install
+}}}
 
-=Build instructions=
+== Feedback ==
 
-autoreconf --install
-./configure
-make check
+See the Google Group yubico-devel:
+http://groups.google.com/group/yubico-devel