summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2021-11-04 10:56:09 +0200
committerPaul Buetow <paul@buetow.org>2021-11-04 10:56:09 +0200
commit8dab24779b56868112dde624ced97846fae0d9bd (patch)
tree5af48cdc7bd9a474470e1036e7fa287b82ec507c
parent94ead01644020eb2e96965294ac22583797a5e4a (diff)
use txt rather than podHEADmaster
-rw-r--r--README.pod114
-rw-r--r--README.txt114
2 files changed, 114 insertions, 114 deletions
diff --git a/README.pod b/README.pod
deleted file mode 100644
index 76de14e..0000000
--- a/README.pod
+++ /dev/null
@@ -1,114 +0,0 @@
-=head1 NAME
-
-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 template.
-
-Follow these steps:
-
-=head2 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.
-
-=head2 Compile the project
-
-Go to the to level directory and run
-
- make
-
-To test run
-
- ./bin/template
-
-It should print out the version number of the project.
-
-=head2 Create a Debian package
-
-Go to the to level directory and run
-
- make deb
-
-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
-
-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
-
-Run
-
- dpkg -L template
-
-to see whats in there. You can now run
-
- /usr/bin/template
-
-or for example
-
- man template
-
-=head2 Read the Makefile
-
-Read the Makefile in order to understand what's going on.
-
-=head1 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:
-
-=head2 Manual page
-
-This template is using POD for creating manual pages. Edit ./docs/template.pod and run
-
- make documentation
-
-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/template.1
-
-=head2 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 \*template\* |
- while read template; do git mv $template ${template/template/$PROJECTNAME}; done
-
-Search all content and rename *template* 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"
-
-=head2 Updating ./debian
-
-Edit the following files accordingly to your new project (e.g. with vim):
-
- vim ./debian/{control,copyright,README}
-
-=head2 Update changelog
-
-Go to the to level directory and run
-
- dch -i
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..5200d1f
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,114 @@
+NAME
+ template - 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
+ template.
+
+ 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/template
+
+ 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:
+
+ ../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 ../template_0.0.0.0_all.deb
+ sudo dpkg -i ../template_0.0.0.0_all.deb
+
+ Run
+
+ dpkg -L template
+
+ to see whats in there. You can now run
+
+ /usr/bin/template
+
+ or for example
+
+ man template
+
+ 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/template.pod and run
+
+ make documentation
+
+ 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/template.1
+
+ 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 \*template\* |
+ while read template; do git mv $template ${template/template/$PROJECTNAME}; done
+
+ Search all content and rename *template* 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"
+
+ Updating ./debian
+ Edit the following files accordingly to your new project (e.g. with
+ vim):
+
+ vim ./debian/{control,copyright,README}
+
+ Update changelog
+ Go to the to level directory and run
+
+ dch -i
+