rename docs files to *.md

Author: iandstanley

BUGS.md

@@ -0,0 +1,29 @@
+
+			BUGS
+			""""
+
+REPORTING
+
+Please report any bugs found to the GitHub repo by filing an issue 
+there.
+
+https://github.com/Standard-Unix-Notes/unix-notes/issues
+
+
+PROGRESS
+
+Progress on bug fixes will be discussed in the comments relating to a 
+previously filed issue.
+
+
+PATCHES
+
+Bug fixes will always be added to HEAD of the repo commit log but may 
+not automatically be packaged and released immediately. You will always 
+be able to download the code direct from the GitHub repo and either 
+'sudo make install' to install the patched version into your system. 
+You may also be able to build a local package of the upto date code at 
+HEAD. For information on building a package with the latest code in the 
+repo see PACKAGING.
+
+

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+
+#		HOW TO CONTRIBUTE
+
+Contributions from other developers are welcomed whether they are new 
+feature related or documentation related.
+
+Please fork repository, make your changes and create a pull request. 
+If the change is a major change to the way the script(s) work, a 
+language translation OR you want to add a feature that would involve 
+significant work, please open a DISCUSSION post to discuss how the 
+implementation would work.   
+
+
+## NEW FEATURE PULL REQUESTS 
+
+Please add sufficient description to the comments of the pull request 
+to describe the additional feature(s) added.
+
+For each feature added the documentation will need to be amended as 
+needed including the README.md file, the man pages in docs/* and where 
+necessary the other documentation files in the root directory of the 
+repo.
+
+
+## DOCUMENTATION PULL REQUESTS
+
+Please run the aspell(1) spelling checker and the diction(1) grammar 
+checker on any documentation changed.
+
+	$ aspell -c <filename>
+
+	$ diction -s <filename> 
+
+
+## BUGS
+
+Known bugs should have a corresponding ISSUE created. 
+
+Pull requests should not have any known bugs before the pull request 
+is created. EXCEPTION: if there is a feature yet-to-be-implemented, 
+please (1) mention this in the pull request comments, and (2) raise an 
+issue of type BUG once pull request is accepted.
+
+
+## FEATURE ROADMAP
+
+Please see the file ROADMAP for a list of features currently being 
+considered by the author for inclusion. This list is NOT exhaustive 
+and contributors should feel free to propose and code for additional 
+features not on the ROADMAP.
+
+-
+ian

PACKAGING.md

@@ -0,0 +1,90 @@
+
+#			PACKAGING NOTES SCRIPT
+
+We welcome contributions from others helping to package NOTES for 
+different BSD/Linux distributions.
+
+
+## CURRENTLY IMPLEMENTED
+
+At of the timestamp of this file we have the following packaging 
+systems implemented for the NOTES system:
+
+- source tarball for use with 'sudo make install'
+- Debian
+- Ubuntu based systems should be able to use the Debian .deb package 
+
+
+## CREATING PACKAGES FROM THE SOURCE TARBALL OR GIT CLONE
+
+Each implemented packaging can be created from the source tarball or a 
+git clone/download by changing directory to the appropriate 
+distribution directory and running make. Obviously you should run the 
+builds on the distribution the makefile is building for (Debian on 
+Debian etc) unless your distribution includes the appropriate target OS 
+packaging software.   
+
+	DEBIAN / UBUNTU
+
+	To create a Debian package from the source: 
+
+	$ cd pkgs/debian
+	$ make deb
+
+	This will create a Debian .deb package and a *.sha256.txt file
+	for the package. The .deb package and the .sha256.txt files
+	will be created in the pkgs/debian directory.
+
+
+## CURRENTLY PLANNED BY AUTHOR
+
+I will be packaging for the following operating systems, based upon the 
+OS I have easily available to me:
+
+- FreeBSD
+
+
+## OTHER PACKAGING DESIRED
+
+We would love to see the scripts packaged for other operating systems 
+including the following:
+
+- Arch Linux 
+- Manjaro Linux
+- Fedora
+
+We will incorporate packaging for any BSD/Linux that contributors would 
+like to commit to building. 
+
+
+## CONTRIBUTING TO PACKAGING
+
+For ease of maintenance, packagers should create a sub directory under 
+[repo]/pkgs named after the distribution (see pkgs/debian, pkgs/freebsd 
+for example). 
+
+Inside that directory there should be a makefile to create the package 
+and all the appropriate files to create the distribution specific package 
+file (.pkg, .deb, etc). 
+
+It should be created in such a way that a simple 'make' in the folder 
+to build the package according to the distribution requirements.
+
+Please ensure that the package has the appropriate dependencies for end 
+users. See the file DEPENDENCIES for details.
+
+
+## CREATING A SOURCE TARBALL FROM THE MAIN SOURCE CODE DIRECTORY
+
+If desired you can make a gzipped tarball of the distribution at the 
+current HEAD of the repo by performing the following in the top 
+directory of the source code:
+
+$ make tarball
+
+This will create a gzipped tarball 'unix-notes-(VERSION)-tar.gz' using 
+the command 'git archive' command and also create a file 
+'unix-notes-(VERSION)-sha256.txt' containing the SHA256 fingerprint of 
+the tarball to help installation security.
+
+

RELEASE-NOTES.md

@@ -0,0 +1,28 @@
+
+			STANDARD(?) UNIX NOTES			
+				
+				ROADMAP
+
+1.0 INITIAL RELEASE
+	- GPG encrypted notes
+	- add/delete/rename notes
+	- multiple notebooks
+	- add/delete/rename notebooks
+	- re-encrypt with new GPG key
+
+IN NEXT RELEASE (IMPLEMENTED)
+	- packaged as a tarball with SHA256
+	- Debian .DEB packaging
+	- Added a 'tree' subcommand for paging through the notes directory
+	- $NOTESDIR env support
+
+FUTURE FEATURES
+	- dedicated diary/journal function
+	- spell checking before encryption using aspell
+	- multiuser encryption
+	- different gpg keys per notebook
+	- git integration
+	- bash/zsh completion
+	- FreeBSD .PKG packaging
+	- FreeBSD ports configuration
+	- XDG environment support

ROADMAP.md

@@ -11,13 +11,17 @@ We support the following versions of this application:
 
 ## Reporting a Vulnerability
 
-If a vulnerability is found please report this as an ISSUE in the Issues tab. 
-If you have a fix ro suggested amendment, please feel free to fork and create a pull-request.
+If a vulnerability is found please report this as an ISSUE in the 
+Issues tab. If you have a fix ro suggested amendment, please feel free 
+to fork and create a pull-request.  
+
 
 ## Expectations and Version
 
-Each release will be released with a nn.0 tag. Vulnerabilities fixes will be fixed and 
-released as a nn.x where x is incremented sequentially with each patch to the 'nn' release.
+Each release will be released with a nn.0 tag. Vulnerabilities fixes 
+will be fixed and released as a nn.x where x is incremented 
+sequentially with each patch to the 'nn' release.  
 
-We do not release fixes for prior versions. Fixes for bugs and vulnerabilities will be 
-added to the working version at HEAD and a nn.x version released.
+We do not release fixes for prior versions. Fixes for bugs and 
+vulnerabilities will be added to the working version at HEAD and a nn.x 
+version released.