summaryrefslogtreecommitdiff
path: root/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'README.txt')
-rw-r--r--README.txt46
1 files changed, 23 insertions, 23 deletions
diff --git a/README.txt b/README.txt
index 5200d1f..815c823 100644
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,5 @@
NAME
- template - A template project
+ netdiff - A netdiff 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
- template.
+ netdiff.
Follow these steps:
@@ -26,7 +26,7 @@ WTF?
To test run
- ./bin/template
+ ./bin/netdiff
It should print out the version number of the project.
@@ -37,27 +37,27 @@ WTF?
It will create the files like:
- ../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
+ ../netdiff_0.0.0.0_all.deb
+ ../netdiff_0.0.0.0.dsc
+ ../netdiff_0.0.0.0_amd64.changes
+ ../netdiff_0.0.0.0.tar.gz
It should create a debian package in ../. Check and install it, e.g:
- lintian --pedantic ../template_0.0.0.0_all.deb
- sudo dpkg -i ../template_0.0.0.0_all.deb
+ lintian --pedantic ../netdiff_0.0.0.0_all.deb
+ sudo dpkg -i ../netdiff_0.0.0.0_all.deb
Run
- dpkg -L template
+ dpkg -L netdiff
to see whats in there. You can now run
- /usr/bin/template
+ /usr/bin/netdiff
or for example
- man template
+ man netdiff
Read the Makefile
Read the Makefile in order to understand what's going on.
@@ -77,29 +77,29 @@ Customize
You should also consider the following:
Manual page
- This template is using POD for creating manual pages. Edit
- ./docs/template.pod and run
+ This netdiff is using POD for creating manual pages. Edit
+ ./docs/netdiff.pod and run
make documentation
- in order to build ./docs/template.1. The page will be included in the
+ in order to build ./docs/netdiff.1. The page will be included in the
resulting debian package automatically. You can review the page with
- man ./docs/template.1
+ man ./docs/netdiff.1
- Renaming template into your project name
- Rename all files which have *template* included into your own new
+ Renaming netdiff into your project name
+ Rename all files which have *netdiff* included into your own new
package name. You can do that with:
PROJECTNAME=yourproject
- find . -name \*template\* |
- while read template; do git mv $template ${template/template/$PROJECTNAME}; done
+ find . -name \*netdiff\* |
+ while read netdiff; do git mv $netdiff ${netdiff/netdiff/$PROJECTNAME}; done
- Search all content and rename *template* into your own new package name.
+ Search all content and rename *netdiff* into your own new package name.
You can do that with:
- grep -R template . | grep -v .git |
- cut -d: -f1 | uniq | xargs sed -i "s/template/$PROJECTNAME/g"
+ grep -R netdiff . | grep -v .git |
+ cut -d: -f1 | uniq | xargs sed -i "s/netdiff/$PROJECTNAME/g"
Updating ./debian
Edit the following files accordingly to your new project (e.g. with