rename to guprecords

1 files changed, 116 insertions, 0 deletions

diff --git a/docs/guprecords.txt b/docs/guprecords.txt
new file mode 100644
index 0000000..968b998
--- /dev/null
+++ b/docs/guprecords.txt
@@ -0,0 +1,116 @@
+NAME
+    guprecords - A template project
+
+WTF?
+    You may use this project in order to build your own Debian package for
+    your own project. This has been tested with Debian GNU/Linux Squeeze and
+    Debian GNU/Linux Wheezy.
+
+    Feel free to modify any aspects. This project is just an empty example
+    guprecords.
+
+    Follow these steps:
+
+  Install required packages
+    Run the following:
+
+        sudo aptitude install lintian devscripts dpkg-dev make perl
+
+    Todo: Ensure this are the correct packages. In order to test that I
+    would have to setup a blank Debian system.
+
+  Compile the project
+    Go to the to level directory and run
+
+        make
+
+    To test run
+
+        ./bin/guprecords
+
+    It should print out the version number of the project.
+
+  Create a Debian package
+    Go to the to level directory and run
+
+        make deb
+
+    It will create the files like:
+
+        ../guprecords_0.0.0.0_all.deb
+        ../guprecords_0.0.0.0.dsc
+        ../guprecords_0.0.0.0_amd64.changes
+        ../guprecords_0.0.0.0.tar.gz
+
+    It should create a debian package in ../. Check and install it, e.g:
+
+        lintian --pedantic ../guprecords_0.0.0.0_all.deb 
+        sudo dpkg -i ../guprecords_0.0.0.0_all.deb
+
+    Run
+
+        dpkg -L guprecords
+
+    to see whats in there. You can now run
+
+        /usr/bin/guprecords
+
+    or for example
+
+        man guprecords
+
+  Read the Makefile
+    Read the Makefile in order to understand what's going on.
+
+Customize
+    Now, since you understood everything feel free to customize everything
+    the way you want it. E.g.:
+
+        Don't use POD for documentation but LaTeX
+
+        Compile a C program
+
+        Include a ./lib dir, add it to the 'install' Makefile rule
+
+        etc etc.
+
+    You should also consider the following:
+
+  Manual page
+    This template is using POD for creating manual pages. Edit
+    ./docs/guprecords.pod and run
+
+        make documentation
+
+    in order to build ./docs/guprecords.1. The page will be included in the
+    resulting debian package automatically. You can review the page with
+
+        man ./docs/guprecords.1
+
+  Renaming guprecords into your project name
+    Rename all files which have *guprecords* included into your own new package
+    name. You can do that with:
+
+        PROJECTNAME=yourproject
+        find . -name \*guprecords\* | 
+        while read guprecords; do git mv $guprecords ${guprecords/guprecords/$PROJECTNAME}; done
+
+    Search all content and rename *guprecords* into your own new package name. You
+    can do that with:
+
+        grep -R guprecords . | grep -v .git | 
+        cut -d: -f1 | uniq | xargs sed -i "s/guprecords/$PROJECTNAME/g"
+
+  Updating ./debian
+    Edit the following files accordingly to your new project (e.g. with
+    vim):
+
+        ./debian/control
+        ./debian/copyright
+        ./debian/README
+
+  Update changelog
+    Go to the to level directory and run
+
+        dch -i
+