• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Jeanne Boyarsky
  • Ron McLeod
  • Paul Clapham
  • Liutauras Vilda
Sheriffs:
  • paul wheaton
  • Rob Spoor
  • Devaka Cooray
Saloon Keepers:
  • Stephan van Hulst
  • Tim Holloway
  • Carey Brown
  • Frits Walraven
  • Tim Moores
Bartenders:
  • Mikalai Zaikin

readme file

 
Ranch Hand
Posts: 32
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I see a lot of threads mentionning the readme file.
Readme file is suuppose to describe th elist of filesin the jar.
My assignment does not mention any readme file. It says that I must provide a userguide.txt file containing a user documentation for the database and the server. I have choice.txt and version.txt files.
But no mention of a readme file?
Is it some thing that must be done as good practice, should I provide a readme file anyway or is it the same file as the userguide.txt?
Cna you help me with this.
Thank you
- Lydie
 
author and jackaroo
Posts: 12200
280
Mac IntelliJ IDE Firefox Browser Oracle C++ Java
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi Lydie,

The Fly By Night Services assignment required a README.txt file (not my choice in capitalization :roll: ). The URLyBird and Bodgit & Scarper assignments do not need this file.

The contents of the README.txt file are almost all irrelevant for the new assignments. In it we had to specify how to start the application (the new assignments must be in an executable jar file), specified where the various files were located (they are now explicitly located as specified in the instructions) and so on.

In other words - since your assignment instructions do not require you to provide this file, don't worry about it.

Regards, Andrew
 
reply
    Bookmark Topic Watch Topic
  • New Topic