Free Essay

Readme

In: People

Submitted By Clarohdez
Words 807
Pages 4
Not to be confused with Reamde, a novel by Neal Stephenson.

The README file for cURL

A readme (or read me) file contains information about other files in a directory or archive and is commonly distributed with computer software, forming part of its documentation. Such a file is usually a text file called README.TXT, README.md, README.1ST, READ.ME, or simply README, although some software may occasionally include a README.WRI, README.RTF, or README.DOC.
The name is chosen so that users unaware of the existence of this type of file would be drawn to read it.
README is traditionally written in upper case, so that on case-preserving environments that display files in an ASCIIbetical ordering by default, such as the ls command in Linux, the name will appear near the beginning of a directory listing (since upper-case letters sort before lower-case letters in
ASCIIbetical ordering).

Contents
The contents typically include one or more of the following:
Configuration instructions
Installation instructions
Operating instructions
A file manifest (list of files included)
Copyright and licensing information

Contact information for the distributor or programmer
Known bugs[1]
Troubleshooting[1]
Credits and acknowledgments
A changelog (usually for programmers)
A news section (usually for users)
The expression "readme file" is also sometimes used descriptively and generically, whereby the files are not named "readme", but are considered types of readme files. The source code distributions of many free software packages, especially those following the Gnits Standards or those produced with GNU Autotools, include a standard set of readme files:
README

General information

AUTHORS

Credits

THANKS

Acknowledgments

CHANGELOG

A detailed changelog, intended for programmers

NEWS

A basic changelog, intended for users

INSTALL

Installation instructions

COPYING / LICENSE Copyright and licensing information
BUGS

Known bugs and instructions on reporting new ones

Other files commonly distributed with software include a FAQ and a TODO file listing possible future changes. History
Since the advent of the web as a de facto standard platform for software distribution, many software packages have moved (or occasionally, copied) some of the above ancillary files and pieces of information to a website or wiki, sometimes including the README itself, or sometimes leaving behind only a brief README file without all of the information required by a new user of the software. However, the popularity of GitHub (as well as older community conventions) has contributed towards README files still being widely-used in open-source software (see next section). On GitHub
On GitHub, if a Git repository has a README file in its main (top-level) directory, the README file is automatically converted into formatted HTML and presented on the main web page of the git repository, underneath the list of files and directories in the repository. Various different file extensions can be used,[2] but there should not be more than one file named "README" at the toplevel of a GitHub repository. The conversion to HTML takes account of the file extension of the file – for example, naming the README file for a GitHub repository "README.md" would cause
GitHub to treat it as a GitHub-flavored

Markdown file, which is also the default README file

format on GitHub.
This makes using GitHub a low-effort way to create a web page for a git repository (GitHub also supports the publication of wikis and separate websites, which may be formatted however the developers want).
Because the GitHub web interface lets users edit a file in a relatively streamlined way, without manually cloning the repository and manually making a pull request, it supports wiki-style editing of the README file[3] – with approval necessary by a committer (i.e. someone who has write access to the repository) if the user is not a committer themselves.
However, within the GitHub app for Android mobile devices, the contents of README files are not shown underneath the list of files,[4] and nor are README files formatted as HTML when viewed.

Further reading
Johnson, Mark (February 1997). "Building a Better ReadMe" . Technical Communication (Society for Technical Communication) 44 (1): 28–36.
Livingston, Brian (14 September 1998). "Check your Readme files to avoid common Windows problems". InfoWorld. Vol. 20 no. 37. p. 34.
Preston-Werner, Tom (23 Aug 2010). "Readme Driven Development" . Tom Preston-Werner's personal blog. Retrieved 30 July 2014.
Streb, Claire (12 Sep 2015). "All Hail the README File!" . Claire N Streb - Expert Remote Senior
Software Engineer's personal blog. Retrieved 12 September 2015.

References
1. ^ a b Manes, Stephen (November 1996). "README? Sure--before I buy!". PC World 14 (11): 366.

2. ^ "Markup" . GitHub. GitHub. 25 December 2014. Retrieved 8 February 2015.
3. ^ "Create A Repo" . GitHub Help. GitHub. Retrieved 8 February 2015.
4. ^ "Issue 206" . GitHub Android app. Retrieved 8 February 2015.
This article is based in part on the Jargon File, which is in the public domain.

Similar Documents

Free Essay

Thesis

...------------------------------------------------------------------ DigitalPersona DigitalPersona Platinum SDK 3.1.1 Readme File April 2005 ------------------------------------------------------------------ (c) DigitalPersona, Inc., 2005. All rights reserved This document provides late-breaking or other information that supplements the DigitalPersona Platinum SDK Guide. ------------------------- How to Use This Document ------------------------- To view the Readme file on-screen in Windows Notepad, maximize the Notepad window. On the Edit menu, click Word Wrap. To print the Readme file, open it in Notepad or another word processor, and then use the Print command on the File menu. --------- CONTENTS --------- 1. INSTALLATION 2. COMPATIBILITY 3. SYSTEM REQUIREMENTS 4. RELEASE NOTES 4.1 XTF Templates 4.2 Changes in Documentation and Header Files 4.3 Sample Code for Delphi 6 4.4 U.are.U 4000B Fingerprint Reader Support 5. KNOWN ISSUES 5.1 Installation on NT4 Computers 5.2 Windows NT4 Multiple Fingerprint Readers Support 5.3 Windows Server 2003 SP1 5.4 Windows Users in the Local Database 5.5 Installation of DigitalPersona Pro Workstation 3.2.1 over DigitalPersona Platinum software 6. SUPPORT AND FEEDBACK ---------------- ...

Words: 947 - Pages: 4

Free Essay

Nimda

...backdoors. If it finds a way in; it will cause the exposed IIS Web server to read an embedded JavaScript that will make the virus circulate to all of the Web pages on that server. When user’s visit the affected sites from the Web server they unknowingly download pages with the embedded script; and then this gives the virus a way to spread to other computers throughout the internet. Users can also be infected within the Web server’s own internal network through network shares. Nimda was also circulating through e-mails’ with a “readme exe” attachment sent to peoples e-mail. Once the user opens the e-mail it causes the virus to circulate more. There are some preventative methods server administrators and end users can to. Administrators can apply patches that Microsoft has provided for past viruses and implement rules that do not allow users to check e-mails at the server. Users can keep their browsers up to date, and do not open e-mails with a “readme exe” attachment. If you have to keep the system running you can disconnect from the internet and restore or reformat the system, then make sure you have the most recent patches. Finally run an antivirus cleaner and re-scan it; if it passes then you can reconnect it to the network. References Rouse, “NIMDA.” Last modified September 2005....

Words: 328 - Pages: 2

Free Essay

Salut!

...README - Application Centralisée de Gestion : REPARTOUT Table des matières README - Application Centralisée de Gestion : REPARTOUT ...............................................................1 I. II. 1. 2. 3. 4. III. 1. 2. 3. 4. Eléments du Projet ......................................................................................................................2 Notice Technique – Application JAVA ..........................................................................................2 Lancement ..............................................................................................................................2 Authentification ......................................................................................................................2 Fonctionnement ......................................................................................................................3 A Propos..................................................................................................................................3 Technical Documentation – JAVA Application ..........................................................................4 Launch ....................................................................................................................................4 Authentification ......................................................................................................................4 Functionment ........................................

Words: 566 - Pages: 3

Free Essay

License

...Sun Microsystems, Inc. Binary Code License Agreement for the JAVATM 2 RUNTIME ENVIRONMENT (J2RE), STANDARD EDITION, VERSION 1.4.2_X SUN MICROSYSTEMS, INC. ("SUN") IS WILLING TO LICENSE THE SOFTWARE IDENTIFIED BELOW TO YOU ONLY UPON THE CONDITION THAT YOU ACCEPT ALL OF THE TERMS CONTAINED IN THIS BINARY CODE LICENSE AGREEMENT AND SUPPLEMENTAL LICENSE TERMS (COLLECTIVELY "AGREEMENT"). PLEASE READ THE AGREEMENT CAREFULLY. BY DOWNLOADING OR INSTALLING THIS SOFTWARE, YOU ACCEPT THE TERMS OF THE AGREEMENT. INDICATE ACCEPTANCE BY SELECTING THE "ACCEPT" BUTTON AT THE BOTTOM OF THE AGREEMENT. IF YOU ARE NOT WILLING TO BE BOUND BY ALL THE TERMS, SELECT THE "DECLINE" BUTTON AT THE BOTTOM OF THE AGREEMENT AND THE DOWNLOAD OR INSTALL PROCESS WILL NOT CONTINUE. 1. DEFINITIONS. "Software" means the identified above in binary form, any other machine readable materials (including, but not limited to, libraries, source files, header files, and data files), any updates or error corrections provided by Sun, and any user manuals, programming guides and other documentation provided to you by Sun under this Agreement. “Programs” mean Java applets and applications intended to run on the Java 2 Platform, Standard Edition (J2SETM platform) platform on Java-enabled general purpose desktop computers and servers. 2. LICENSE TO USE. Subject to the terms and conditions of this Agreement, including, but not limited to the Java Technology Restrictions of the Supplemental License Terms, Sun grants you...

Words: 2235 - Pages: 9

Free Essay

Nfs Mw Mod Loader

...NFSMW Mod Loader and Ferrari 360 Spider Mod for Need For Speed Most Wanted July 20, 2006 README (version 1.0a) Welcome ======= You have just downloaded the world's first community created custom car modification for NFSMW. It is recommended that you read this readme file completely before proceeding. In order to use this mod, you will require version 1.3 of NFSMW. If you haven't patched your game at any time, you are still running version 1.2. You can download the 1.3 patch from: ftp://largedownloads.ea.com/pub/patches/nfsmwpatch1.3.exe Run install.exe to install NFSMW Mod Loader and the Ferrari 360 Spider Mod. You can launch the game by using the "Need for Speed™ Most Wanted (Mod Loader)" shortcut on your desktop or in your start menu under the regular NFSMW start menu folder. If you launch the game with the regular "Need for Speed™ Most Wanted" shortcut, the Mod Loader will be disabled, and none of the installed mods will be loaded. None of the game-related files are replaced by installing this mod. The Ferrari 360 Spider mod works by replacing an existing car in the game. The car which the mod replaces is the Mercedes SL65. To select this car, navigate to the "Bonus Cars" screen and select it. If you do not have the Black Edition version, you may be required to finish certain portions of the game before the car will be unlocked. Alternatively...

Words: 779 - Pages: 4

Free Essay

Ewrwqer

...OS BIG Editor v0.5 Readme --------------------- 1. Product Info 2. Product History 3. To do, future features 4. Version history 5. Contact 6. Homepages/Links 7. Source 8. Updates --------------------- 1. Product Info - Src: Delphi 2005 Personal Edition - Compiled: March 9, 2007, 5:02 AM GMT - Current version: 0.5 - Authors: Banshee 2. Product History Version 0.5 Interface improved again, program may now open and extract files through drag and drop. TGA files will be previewed in the program. OS BIG Editor is now able to associate .big files with it and several options were added to make the program more confortable for the user. These options are also saved everytime the program is closed and loaded in the next time. Version 0.4 Interface improved, program may now open files by parameters, file size and compression size showed when user selects it and extract will now extract all selected files. Version 0.3 First public version of the program, basic extracting tools. 3. To do, Future features - .manifest/.imp/.relo/.bin support - create and edit BIG files - compress files inside the .BIG package with RefPack compression. - preview DDS and few other binaries. - tree view - additional parameter support 4. Version History 0.5 - revisions by Banshee: - Added: Associate .big files with OS BIG Editor at Options -> Preferences (Note: the second and third icons were made by Danny van Loon). - Added:...

Words: 574 - Pages: 3

Free Essay

Adobe Installation Guide

...Adobe® Acrobat® 9 Pro Extended software Welcome to the Adobe Acrobat 9 Pro Extended ReadMe, which contains essential information on the product. For Adobe Acrobat 9 product support information see http://www.adobe.com/go/acrobat_support For information about Adobe LiveCycle Designer, a forms authoring application installed with Acrobat 9 Pro Extended, see the ReadMe file located in the Designer 8.2/Documentation/EN folder. Designer is installed in the Program Files/Adobe/Acrobat9.0/Designer 8.2 folder. System Requirements Acrobat 9 Pro Extended for Windows® requires the following: · 1.3 Gigahertz processor or higher · Microsoft® Windows® XP Microsoft® Windows® XP Home, Professional, or Tablet PC Edition with Service Pack 2 or 3 (32-bit and 64-bit); Windows Server® 2003 (with Service Pack 2 for 64-bit); or Windows Vista® Home Basic, Home Premium, Business, Ultimate, or Enterprise with or without Service Pack 1 (32-bit and 64-bit) · MS Hot Fix KB-930627: http://support.microsoft.com/kb/930627 is required for Microsoft® Windows® XP Home, Professional, or Tablet PC Edition with Service Pack 2 (64-bit); Windows Server® 2003 (with Service Pack 2 for 64-bit); or Windows Vista® Home Basic, Home Premium, Business, Ultimate, or Enterprise without Service Pack 1 (64-bit) · 512 MB of installed RAM · 2.4 GB of available hard disk (Note: The installer creates temporary files during installation so the actual...

Words: 1003 - Pages: 5

Premium Essay

10 Grammar Mistakes That Make You Look Stupid

...triathlete to spot such mistakes. They have a way of doing a little wiggle dance on the screen and then reaching out to grab the reader by the throat. So here we are in the era of Word's red-underline "wrong spelling, dumb ass" feature and Outlook's Always Check Spelling Before Sending option, and still the mistakes proliferate. Catching typos is easy (although not everyone does it). It's the other stuff -- correctly spelled but incorrectly wielded -- that sneaks through and makes us look stupid. Here's a quick review of some of the big ones. 1. Loose for lose No: I always loose the product key. Yes: I always lose the product key. 2. It's for its (or god forbid, its') No: Download the HTA, along with it's readme file. Yes: Download the HTA, along with its readme file. No:...

Words: 1040 - Pages: 5

Premium Essay

Hitman

...Hitman 2: Silent Assassin README file 19/09/2002 Version 1.0 Part 1: Things You Should Know Please read through the DirectX section of this document. This section has information that is vital to successfully running Hitman 2: Silent Assassin on your system. 1.1 DirectX This game is optimised for Microsoft's DirectX 8.1. In order for you to play the game, you must have DirectX 8.1 compliant drivers for your video card and sound card. Please note that although DirectX 8.1 is installed with the game, your video and sound card drivers will not be upgraded to DirectX 8.1 drivers. You will need to obtain the latest DirectX 8.1 drivers from your card manufacturer or PC supplier. These drivers cannot be supplied by Eidos. 1.2 Memory and Performance While the game will run fine in 128 Mb of RAM, your playing experience will be smoother if you have at least 192 Mb. Regardless of how much memory you have, you can maximize your available memory and increase the overall performance of the game engine by doing the following: q Closing any open windows q Shutting down all other programs, including menu-bar programs like ICQ q Defragmenting your hard drive Eidos recommends that you have no other programs running at all while playing Hitman 2: Silent Assassin. Other programs, including virus checkers, system utilities and screen savers can cause system degradation when playing games software and may conflict with the game for system resources, potentially...

Words: 3112 - Pages: 13

Free Essay

Zsfdzfdzf

...================================================================== Robin Hood – The Legend of Sherwood v1.0 Readme file – October 25th, 2002 ================================================================== Thank you for purchasing Robin Hood – The Legend of Sherwood. The Spellbound Team wishes you a lot of fun with their new game. This readme file contains useful information that could help you to solve problems with the game. ================================================================== CONTENTS Getting Started · System Requirements · DirectXtm and driver information · Installing and starting the game · Uninstallation Problems and Solutions · Performance optimisation on slow systems · Known problems · Technical Support ================================================================== GETTING STARTED ================================================================== System Requirements ------------------------------------------------------------------ OS: Windows 98/ME/2000/XP CPU: 233 MHz Intel Pentium II or similar CPU RAM: 64 MB CD/DVD-ROM speed: 4x Hard drive space: 1GB available Video: 4 MB RAM and DirectXtm-compatible Sound: DirectXtm compatible sound device Input: Keyboard, Mouse Recommended: CPU: 500 MHz Pentium III or similar CPU RAM: 128 MB DirectXtm and driver information ------------------------------------------------------------------ ...

Words: 1079 - Pages: 5

Free Essay

Fbx Term Paper

..."Register" button and paste or type in your FBX Exporter serial code* into the Serial Number field. Finally, click on the "Accept" button to finish the registration process. You may need to close DAZ Studio and reopen it before you can start using the FBX Exporter. *The FBX Exporter serial code will only be listed in your "Available Serial Codes" section of your www.daz3d.com account if you purchased the plugin separately or as part of the Game Developers Kit. You can also use the Game Developers Kit serial code to register the FBX Exporter. Notes: • Instructions on how to use this product can be found in the User’s Documentation on the DAZ Wiki located here: http://artzone.daz3d.com/wiki/doku.php/pub/software/fbx/start • You can find the Readme for this product located here:...

Words: 397 - Pages: 2

Premium Essay

Seriously?

...English Adobe® Photoshop® Lightroom® 4 Readme Welcome to Adobe® Photoshop® Lightroom® 4. This document contains late-breaking product information, feature notes, and troubleshooting tips not covered in the Lightroom documentation. Minimum System Requirements Installing Lightroom 4 Serial Numbers Upgrade Notes General Program Notes Working with Lightroom 4 and Adobe Photoshop Camera Raw Customer Care Other Resources Minimum system requirements Windows  Processor: Intel® Pentium 4 or AMD Athlon® 64  OS: Microsoft® Windows® 7 with Service Pack 1, Windows Vista® Home Premium, Business, Ultimate, or Enterprise (certified for 32-bit and 64-bit editions) with Service Pack 2  RAM: 2 GB  Hard Disk: 1 GB of available hard-disk space  Media: DVD-ROM drive  Display: 1024 x 768 Monitor Resolution  Internet connection required for Internet-based services Macintosh  Processor: Multicore Intel® processor with 64-bit support  OS: Mac OS X 10.6.8 (Snow Leopard) or MAC OS X 10.7 (Lion)  RAM: 2 GB  Hard Disk: 1 GB of available hard-disk space  Media: DVD-ROM drive  Display: 1024 x 768 Monitor Resolution  Internet connection required for Internet-based services Installing Lightroom 4 Do one of the following 1. Insert the DVD in your drive, and follow the on-screen instructions. If the installer does not launch automatically, double-click DVD Volume: Lightroom 4\Install Lightroom 4 (Windows) or Adobe Photoshop Lightroom 4.pkg (Mac OS) at the root level of...

Words: 320 - Pages: 2

Free Essay

Gpu Flashing

...I will not take any responsibility for damages caused by flashing the BIOS. Use the guide and the BIOS files at your own risk, this will void your warranty. What you need: GPU-Z, Nvflash The following guide is for single GPUs. If you wish to flash multiple cards please do so one at a time or see the Nvflash readme for further instructions on how to use the commands to properly flash multiple card systems. Don't type in the bracket but type in the info in the brackets. The commands are case sensitive and you need to include the spaces, please be accurate. 1. Backup your old BIOS (GPU-Z, BIOS version field, button on the right allows you to save the current bios). Keep the old bios in the event that something happens during the flash. 2. Download the new BIOS you'll be flashing to, it should be a.rom file, otherwise the flash will not work. 3. Browse to your Nvflash folder 4. Transfer the new BIOS file into the Nvflash folder 5. Close all unnecessary programs 6. Shift + right-click the Nvflash folder 7. choose the open in command line option 8. Type in the command: Nvflash --protectoff (case sensitive, please be accurate) 9. Type in the command: Nvflash -4 -5 -6 [yourbiosnamehere].rom 10. If the flash is a cross vendor one you might have to type in y a couple of times when asked to 11. Nvflash will work for a while and close the 2nd command prompt after finishing 12. Reboot 13. Your card should now be flashed, test with Precision...

Words: 554 - Pages: 3

Free Essay

Rhoms

...Info Original one was by marsoff. Redesigned and optimized it. World of Tanks v0.8.5 ready! Installation - Copy the "res_mods" folder to: "\WORLD OF TANKS" - Optional* Copy the CROSSHAIR_PANEL_STRATEGIC .SWF you like from the "arty-mode\[type]" folder to: "\WORLD OF TANKS\RES_MODS\0.8.5\GUI\FLASH" Changelog 1.25 - Artillery angle added back into DebugPanel.swf - Zoom out added - Clock moved back to DebugPanel.swf 1.24 - XVM v3.5.0 removed 1.23 - World of Tanks v0.8.5 supported - Green, blue or original aim-circles available through in-game settings - Visibility of aim-circles optimized - Crosshair colors optimized - Version of Artillery crosshair with shell travel time removed - XVM v3.5.0 included with config matching crosshair colors - Artillery and Tank Destroyer angle indicators moved to minimap (XVM) - Clock top left moved to config (XVM) - J1mB0’s logo added as player icon (XVM) 1.22 - World of Tanks v0.8.4 supported - Angle indicator added for Tank Destroyers 1.21 - World of Tanks v0.8.3 supported 1.20 - DebugPanel.swf reintroduced with clock - Font in FragCorrelation.swf fixed 1.19 - World of Tanks v0.8.2 supported - Clock removed - Angle indicator moved to FragCorrelation.swf 1.18 - World of Tanks v0.8.1 supported - Angle indicator for Artillery added - Clock added to DebugPanel 1.17 - World of Tanks v0.8.0 supported - Artillery aiming optimized - Angle indicator for Artillery removed 1.16 - World of Tanks v0.7.5 supported - My logo used as lag indicator...

Words: 549 - Pages: 3

Free Essay

Simple

...Batman: Arkham Asylum README file 11/08/2009 Version 1.0 Table of contents: Part 1: Things You Should Know 1.1 DirectX 1.2 Memory and Performance 1.3 Known Issues Part 2: Technical Issues 2.1 Installation & Set-up 2.2 DVD-ROM Problems 2.3 Crashes and Lock-Ups 2.4 Firewall and Required Ports 2.5 Technical Support Part 1: Things You Should Know Please read through the DirectX section of this document. This section has information that is vital to successfully running Batman: Arkham Asylum on your system. 1.1 DirectX This game is optimised for Microsoft's DirectX 9.0c. In order for you to play the game, you must have DirectX 9.0c compliant drivers for your video card and sound card. Please note that although DirectX 9.0c is installed with the game, your video and sound card drivers will not be upgraded to DirectX 9.0c drivers. You will need to obtain the latest DirectX 9.0c drivers from the manufacturer or PC supplier. These drivers cannot be supplied by Eidos. 1.2 Memory and Performance While the game will run fine in 1GB of RAM (2GB on Windows Vista), your playing experience will be smoother if you have more memory. Regardless of how much memory you have, you can maximize your available memory and increase the overall performance of the game engine by doing the following: q Closing any open windows q Shutting down all other programs (including those that run in the menu-bar) q Defragmenting your hard drive q Shutting...

Words: 1925 - Pages: 8