Skip to content

Commit 04c4b96

Browse files
committed
Links and version bump in the README.
1 parent 1b27171 commit 04c4b96

2 files changed

Lines changed: 17 additions & 8 deletions

File tree

‎README.html‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
66
<meta name="generator" content="Docutils 0.11: http://docutils.sourceforge.net/" />
7-
<title>D:GameVFS 0.1</title>
7+
<title>D:GameVFS 0.2</title>
88
<style type="text/css">
99

1010
/*
@@ -338,8 +338,8 @@
338338
</style>
339339
</head>
340340
<body>
341-
<div class="document" id="d-gamevfs-0-1">
342-
<h1 class="title">D:GameVFS 0.1</h1>
341+
<div class="document" id="d-gamevfs-0-2">
342+
<h1 class="title">D:GameVFS 0.2</h1>
343343

344344
<div class="section" id="introduction">
345345
<h1>Introduction</h1>
@@ -357,7 +357,8 @@ <h1>Introduction</h1>
357357
<h1>Features</h1>
358358
<ul class="simple">
359359
<li>File system independent, easy to use API for file/directory manipulation.</li>
360-
<li>Detailed API documentation with code examples.</li>
360+
<li>Detailed <a class="reference external" href="http://defenestrate.eu/docs/dgamevfs">API documentation</a> with code
361+
examples.</li>
361362
<li>No external dependencies.</li>
362363
<li>Seamless access to multiple directories as if they were a single directory.</li>
363364
<li>Easy to extend with custom file system backend.</li>
@@ -383,7 +384,8 @@ <h1>Directory structure</h1>
383384
<td>This README file, utility scripts.</td>
384385
</tr>
385386
<tr><td><tt class="docutils literal">./doc</tt></td>
386-
<td>Documentation.</td>
387+
<td>API documentation, also found
388+
<a class="reference external" href="http://defenestrate.eu/docs/dgamevfs">online</a></td>
387389
</tr>
388390
<tr><td><tt class="docutils literal">./source</tt></td>
389391
<td>Source code.</td>
@@ -499,6 +501,8 @@ <h2>Explanation of the code</h2>
499501
length. We determine how large buffer we need to read the entire file with the
500502
<em>VFSFile.bytes()</em> method. The buffer might also be larger than the file - <em>read()</em> reads
501503
as much data as available and returns the part of the buffer containing the read data.</p>
504+
<p>For more details about D:GameVFS API, see the
505+
<a class="reference external" href="http://defenestrate.eu/docs/dgamevfs">documentation</a>.</p>
502506
</div>
503507
<div class="section" id="compiling">
504508
<h2>Compiling</h2>

‎README.rst‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
=============
2-
D:GameVFS 0.1
2+
D:GameVFS 0.2
33
=============
44

55
------------
@@ -24,7 +24,8 @@ Features
2424
--------
2525

2626
* File system independent, easy to use API for file/directory manipulation.
27-
* Detailed API documentation with code examples.
27+
* Detailed `API documentation <http://defenestrate.eu/docs/dgamevfs>`_ with code
28+
examples.
2829
* No external dependencies.
2930
* Seamless access to multiple directories as if they were a single directory.
3031
* Easy to extend with custom file system backend.
@@ -41,7 +42,8 @@ Directory structure
4142
Directory Contents
4243
=============== =======================================================================
4344
``./`` This README file, utility scripts.
44-
``./doc`` Documentation.
45+
``./doc`` API documentation, also found
46+
`online <http://defenestrate.eu/docs/dgamevfs>`_
4547
``./source`` Source code.
4648
``./examples`` Code examples.
4749
=============== =======================================================================
@@ -176,6 +178,9 @@ length. We determine how large buffer we need to read the entire file with the
176178
*VFSFile.bytes()* method. The buffer might also be larger than the file - *read()* reads
177179
as much data as available and returns the part of the buffer containing the read data.
178180

181+
For more details about D:GameVFS API, see the
182+
`documentation <http://defenestrate.eu/docs/dgamevfs>`_.
183+
179184

180185
^^^^^^^^^
181186
Compiling

0 commit comments

Comments
 (0)