Hi,
It's a good practice to have some README file in your GitHub project. It
makes the project easier to understand and use.
That's why I suggest to use at least a minimalistic one, for instance
the one we have in https://github.com/yast/yast-yast2 project.
Here's the RAW data for README.markdown:
--- cut ---
# YaST ${NAME} - ${WHAT_IS_THE_PROJECT_GOOD_FOR} #
This repository contains basic set of shared libraries and so-called SCR
agents used for reading and writing configuration files and some even
for executing commands on the system.
${REPLACE_WITH_SHORT_DESCRIPTION}
## Installation ##
make -f Makefile.cvs
make
sudo make install
## Running Testsuites ##
make check
## Links ##
* See more at http://en.opensuse.org/openSUSE:YaST_development
--- cut ---
Thanks & Bye
Lukas
--
Lukas Ocilka, Cloud & Systems Management Department
SUSE LINUX s.r.o., Praha
--
To unsubscribe, e-mail: [email protected]
To contact the owner, e-mail: [email protected]
