Skip to content
This repository has been archived by the owner on May 29, 2018. It is now read-only.

Commit

Permalink
Merge pull request #58 from gower/vfsbuilder
Browse files Browse the repository at this point in the history
VFS builder documentation update
  • Loading branch information
chessmaster42 committed May 7, 2012
2 parents 1d21e6e + 9391ff0 commit 2eb0e12
Show file tree
Hide file tree
Showing 2 changed files with 142 additions and 122 deletions.
31 changes: 16 additions & 15 deletions utilities/vfsbuilder/README
@@ -1,38 +1,39 @@
AtlasOS VFS Builder

Author: Gower
Version: Hazy

AtlasOS VFS Builder
by Gower
(Use at own risk, absolutely no warranty provided.)

Version: Murky
Builds the virtual file system (VFS) for AtlasOS.

Use at own risk, absolutely no warranty provided.
USAGE:
python vfsbuilder.py

OPTIONS:
-a, --atlas <dir> AtlasOS directory
-r, --root <dir> The directory to use as the root of the VFS
-h, --help Displays this message

----- Introduction -----

The virtual file system (VFS) allows you to pre-load AtlasOS with files, at
least until real storage becomes widely available for DCPU-16 emulators.

VFS Builder is a quick way to create the VFS (which is basically an assembly
file which is included alongside the kernel) by looking at a given directory
file which is assembled alongside the kernel) by looking at a given directory
and indexing the files and subdirectories in it, then looking at each file in
turn and creating the assembly code equivalent (i.e. a lot of dats and hex).

Python is required to use this script (tested on 3.0, although should work on
earlier versions to).


----- Usage -----

python utilities/vfsbuilder/vfsbuilder.py
Options:
-a, --atlas: Define the AtlasOS directory
-r, --root: Define the directory to convert to the VFS
Python is required to use this script (tested on 2.6, although should work on
earlier versions too).

By default, VFS Builder assumes that it is being executed from the AtlasOS
directory will look to compile for the directory misc/vfs. If this is not the
case the above options will need to be used.

----- Specifying Flags -----

By default, all files will be readable and writable from within AtlasOS. To
change this, you can specify flags in the file name. For example:
'--re.myfile.bin'
Expand Down

0 comments on commit 2eb0e12

Please sign in to comment.