search

iserifith / ScoreBoard

0 stars 0 forks source link

Create readme.md file #4

Open mrafsyam opened 8 years ago

mrafsyam commented 8 years ago

The purpose is to learn "documentation" skills, which are required in industry.

Create at Github, using the green button at project homepage. Fill in readme.md file with the following and ADD MORE INFO.

  1. {Project Title} One Paragraph of project description goes here Add screenshots if possible (drag the image file to here)
  2. Prerequisities What things you need to install/run the software
  3. Compilation A step by step on how to compile the source code
  4. Run A step by step on how to run the application
  5. Version {current version number - start with 1.0}
  6. License Later learn how to license a digital project Example : This project is licensed under the MIT License - see the LICENSE.md file for details
  7. Acknowledgments References, links are credited here
mrafsyam commented 8 years ago

Don't need to be long. But try to provide as details as possible. There is no right or wrong, here.

mrafsyam commented 8 years ago

Not enough

@iserifith Please try to follow the list of items as discussed above. Add little bit more on how to compile a java application and how to run a java application

and also please use the following : https://guides.github.com/features/mastering-markdown/

The syntax is called "markdown" - this is what they used in industry for Application WIKI

mrafsyam commented 8 years ago

@iserifith

Update again this readme.md by Weds, 28th

  1. How to compile java source code from command line
  2. How to package the whole source code into .jar file
  3. How to run the jar file
  4. Screenshot of the latest version

Do some research on these topics.