diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/template.1 (renamed from docs/foo.1) | 48 | ||||
| -rw-r--r-- | docs/template.pod (renamed from docs/foo.pod) | 44 | ||||
| -rw-r--r-- | docs/template.txt (renamed from docs/foo.txt) | 44 |
3 files changed, 68 insertions, 68 deletions
diff --git a/docs/foo.1 b/docs/template.1 index 57ca229..3e2d73d 100644 --- a/docs/foo.1 +++ b/docs/template.1 @@ -124,18 +124,18 @@ .\" ======================================================================== .\" .IX Title "FOO 1" -.TH FOO 1 "2014-02-03" "foo 0.0.0.0" "User Commands" +.TH FOO 1 "2014-02-03" "template 0.0.0.0" "User Commands" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -foo \- A template project +template \- A template project .SH "WTF?" .IX Header "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. .PP -Feel free to modify any aspects. This project is just an empty example foo. +Feel free to modify any aspects. This project is just an empty example template. .PP Follow these steps: .SS "Install required packages" @@ -158,7 +158,7 @@ Go to the to level directory and run To test run .PP .Vb 1 -\& ./bin/foo +\& ./bin/template .Ve .PP It should print out the version number of the project. @@ -173,35 +173,35 @@ Go to the to level directory and run It will create the files like: .PP .Vb 4 -\& ../foo_0.0.0.0_all.deb -\& ../foo_0.0.0.0.dsc -\& ../foo_0.0.0.0_amd64.changes -\& ../foo_0.0.0.0.tar.gz +\& ../template_0.0.0.0_all.deb +\& ../template_0.0.0.0.dsc +\& ../template_0.0.0.0_amd64.changes +\& ../template_0.0.0.0.tar.gz .Ve .PP It should create a debian package in ../. Check and install it, e.g: .PP .Vb 2 -\& lintian \-\-pedantic ../foo_0.0.0.0_all.deb -\& sudo dpkg \-i ../foo_0.0.0.0_all.deb +\& lintian \-\-pedantic ../template_0.0.0.0_all.deb +\& sudo dpkg \-i ../template_0.0.0.0_all.deb .Ve .PP Run .PP .Vb 1 -\& dpkg \-L foo +\& dpkg \-L template .Ve .PP to see whats in there. You can now run .PP .Vb 1 -\& /usr/bin/foo +\& /usr/bin/template .Ve .PP or for example .PP .Vb 1 -\& man foo +\& man template .Ve .SS "Read the Makefile" .IX Subsection "Read the Makefile" @@ -223,32 +223,32 @@ Now, since you understood everything feel free to customize everything the way y You should also consider the following: .SS "Manual page" .IX Subsection "Manual page" -This template is using \s-1POD\s0 for creating manual pages. Edit ./docs/foo.pod and run +This template is using \s-1POD\s0 for creating manual pages. Edit ./docs/template.pod and run .PP .Vb 1 \& make documentation .Ve .PP -in order to build ./docs/foo.1. The page will be included in the resulting debian package automatically. You can review the page with +in order to build ./docs/template.1. The page will be included in the resulting debian package automatically. You can review the page with .PP .Vb 1 -\& man ./docs/foo.1 +\& man ./docs/template.1 .Ve -.SS "Renaming foo into your project name" -.IX Subsection "Renaming foo into your project name" -Rename all files which have *foo* included into your own new package name. You can do that with: +.SS "Renaming template into your project name" +.IX Subsection "Renaming template into your project name" +Rename all files which have *template* included into your own new package name. You can do that with: .PP .Vb 3 \& PROJECTNAME=yourproject -\& find . \-name \e*foo\e* | -\& while read foo; do git mv $foo ${foo/foo/$PROJECTNAME}; done +\& find . \-name \e*template\e* | +\& while read template; do git mv $template ${template/template/$PROJECTNAME}; done .Ve .PP -Search all content and rename *foo* into your own new package name. You can do that with: +Search all content and rename *template* into your own new package name. You can do that with: .PP .Vb 2 -\& grep \-R foo . | grep \-v .git | -\& cut \-d: \-f1 | uniq | xargs sed \-i "s/foo/$PROJECTNAME/g" +\& grep \-R template . | grep \-v .git | +\& cut \-d: \-f1 | uniq | xargs sed \-i "s/template/$PROJECTNAME/g" .Ve .SS "Updating ./debian" .IX Subsection "Updating ./debian" diff --git a/docs/foo.pod b/docs/template.pod index e8c4172..76de14e 100644 --- a/docs/foo.pod +++ b/docs/template.pod @@ -1,12 +1,12 @@ =head1 NAME -foo - A template project +template - A template project =head1 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 foo. +Feel free to modify any aspects. This project is just an empty example template. Follow these steps: @@ -26,7 +26,7 @@ Go to the to level directory and run To test run - ./bin/foo + ./bin/template It should print out the version number of the project. @@ -38,27 +38,27 @@ Go to the to level directory and run It will create the files like: - ../foo_0.0.0.0_all.deb - ../foo_0.0.0.0.dsc - ../foo_0.0.0.0_amd64.changes - ../foo_0.0.0.0.tar.gz + ../template_0.0.0.0_all.deb + ../template_0.0.0.0.dsc + ../template_0.0.0.0_amd64.changes + ../template_0.0.0.0.tar.gz It should create a debian package in ../. Check and install it, e.g: - lintian --pedantic ../foo_0.0.0.0_all.deb - sudo dpkg -i ../foo_0.0.0.0_all.deb + lintian --pedantic ../template_0.0.0.0_all.deb + sudo dpkg -i ../template_0.0.0.0_all.deb Run - dpkg -L foo + dpkg -L template to see whats in there. You can now run - /usr/bin/foo + /usr/bin/template or for example - man foo + man template =head2 Read the Makefile @@ -80,26 +80,26 @@ You should also consider the following: =head2 Manual page -This template is using POD for creating manual pages. Edit ./docs/foo.pod and run +This template is using POD for creating manual pages. Edit ./docs/template.pod and run make documentation -in order to build ./docs/foo.1. The page will be included in the resulting debian package automatically. You can review the page with +in order to build ./docs/template.1. The page will be included in the resulting debian package automatically. You can review the page with - man ./docs/foo.1 + man ./docs/template.1 -=head2 Renaming foo into your project name +=head2 Renaming template into your project name -Rename all files which have *foo* included into your own new package name. You can do that with: +Rename all files which have *template* included into your own new package name. You can do that with: PROJECTNAME=yourproject - find . -name \*foo\* | - while read foo; do git mv $foo ${foo/foo/$PROJECTNAME}; done + find . -name \*template\* | + while read template; do git mv $template ${template/template/$PROJECTNAME}; done -Search all content and rename *foo* into your own new package name. You can do that with: +Search all content and rename *template* into your own new package name. You can do that with: - grep -R foo . | grep -v .git | - cut -d: -f1 | uniq | xargs sed -i "s/foo/$PROJECTNAME/g" + grep -R template . | grep -v .git | + cut -d: -f1 | uniq | xargs sed -i "s/template/$PROJECTNAME/g" =head2 Updating ./debian diff --git a/docs/foo.txt b/docs/template.txt index bf913ac..bd93178 100644 --- a/docs/foo.txt +++ b/docs/template.txt @@ -1,5 +1,5 @@ NAME - foo - A template project + template - A template project WTF? You may use this project in order to build your own Debian package for @@ -7,7 +7,7 @@ WTF? Debian GNU/Linux Wheezy. Feel free to modify any aspects. This project is just an empty example - foo. + template. Follow these steps: @@ -26,7 +26,7 @@ WTF? To test run - ./bin/foo + ./bin/template It should print out the version number of the project. @@ -37,27 +37,27 @@ WTF? It will create the files like: - ../foo_0.0.0.0_all.deb - ../foo_0.0.0.0.dsc - ../foo_0.0.0.0_amd64.changes - ../foo_0.0.0.0.tar.gz + ../template_0.0.0.0_all.deb + ../template_0.0.0.0.dsc + ../template_0.0.0.0_amd64.changes + ../template_0.0.0.0.tar.gz It should create a debian package in ../. Check and install it, e.g: - lintian --pedantic ../foo_0.0.0.0_all.deb - sudo dpkg -i ../foo_0.0.0.0_all.deb + lintian --pedantic ../template_0.0.0.0_all.deb + sudo dpkg -i ../template_0.0.0.0_all.deb Run - dpkg -L foo + dpkg -L template to see whats in there. You can now run - /usr/bin/foo + /usr/bin/template or for example - man foo + man template Read the Makefile Read the Makefile in order to understand what's going on. @@ -78,28 +78,28 @@ Customize Manual page This template is using POD for creating manual pages. Edit - ./docs/foo.pod and run + ./docs/template.pod and run make documentation - in order to build ./docs/foo.1. The page will be included in the + in order to build ./docs/template.1. The page will be included in the resulting debian package automatically. You can review the page with - man ./docs/foo.1 + man ./docs/template.1 - Renaming foo into your project name - Rename all files which have *foo* included into your own new package + Renaming template into your project name + Rename all files which have *template* included into your own new package name. You can do that with: PROJECTNAME=yourproject - find . -name \*foo\* | - while read foo; do git mv $foo ${foo/foo/$PROJECTNAME}; done + find . -name \*template\* | + while read template; do git mv $template ${template/template/$PROJECTNAME}; done - Search all content and rename *foo* into your own new package name. You + Search all content and rename *template* into your own new package name. You can do that with: - grep -R foo . | grep -v .git | - cut -d: -f1 | uniq | xargs sed -i "s/foo/$PROJECTNAME/g" + grep -R template . | grep -v .git | + cut -d: -f1 | uniq | xargs sed -i "s/template/$PROJECTNAME/g" Updating ./debian Edit the following files accordingly to your new project (e.g. with |