• 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 all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Paul Clapham
  • Jeanne Boyarsky
  • Junilu Lacar
  • Henry Wong
Sheriffs:
  • Ron McLeod
  • Devaka Cooray
  • Tim Cooke
Saloon Keepers:
  • Tim Moores
  • Stephan van Hulst
  • Frits Walraven
  • Tim Holloway
  • Carey Brown
Bartenders:
  • Piet Souris
  • salvin francis
  • fred rosenberger

Summary of uploading process

 
Ranch Hand
Posts: 75
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I read a lot regarding documenting sources, building jars, writing desing docs and readme.txt. I'd like to summarize my impression about it and discuss with others the result.
1. Java docs.
I create docs for all files (changed, added and original) putting in the docs only public and protected methods' descriptions.
2. I make one desing doc (HTML file) describing all my design choices and the architecture.
3. My jars come together in one jar file and insode are grouped in the next way.
Client.jar - all classes necessary for starting the client without remote stubs.
Server.jar - all classes for the server side.
Doc.jar - design doc and javadoc files.
db.db - the original database file (not jared)
Sources.jar - all sources together
scjd.policy - all permision allowed policy file
README.txt - instructions for an examiner how to unpack and start the server and the client
4. All my jars are accompanied by manifest files and hence selfexecuted.
I haven't done the readme file but there is no reef I hope there.
Please join my topic to enrich ourself together in this pretty stupid area.
[ February 25, 2002: Message edited by: Roman Rytov ]
 
Ranch Hand
Posts: 124
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
What about the user manual ?
 
Roman Rytov
Ranch Hand
Posts: 75
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If I forgot - sorry. I did it in HTML format and put it in doc.ajr
 
Mathew Sam
Ranch Hand
Posts: 124
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Looks Fine
 
Are you okay? You look a little big. Maybe this tiny ad will help:
Devious Experiments for a Truly Passive Greenhouse!
https://www.kickstarter.com/projects/paulwheaton/greenhouse-1
    Bookmark Topic Watch Topic
  • New Topic