Better doku F
This commit is contained in:
@@ -1,36 +1,46 @@
|
||||
# Purpose of this document
|
||||
This document is an attempt to recreate the original documentation of FoxBin2Prg out of CodePlex.
|
||||
I found the documentation on [foxbin2prg](https://github.com/fdbozzo/foxbin2prg/blob/master/README.md) a bit brief. For a short what and why, see there.
|
||||
# Home
|
||||
Documentation of FoxBin2Prg - A Binary to Text converter for MS Visual Foxpro 9
|
||||
|
||||
The original document was created by [Fernando D. Bozzo](https://github.com/fdbozzo) whom I like to thank for the great project. Pictures are taken from the original project.
|
||||
## Purpose of this document
|
||||
This document introduce the basic ideas of FoxBin2Prg
|
||||
|
||||
The original document was created by [Fernando D. Bozzo](https://github.com/fdbozzo) whom I like to thank for the great project.
|
||||
Pictures are taken from the original project.
|
||||
As far as possible these are the original documents. Changes are added where functionality is changed.
|
||||
|
||||
----
|
||||

|
||||
This project is part of VFPX.
|
||||
## Table of contents
|
||||
- [Source](#source)
|
||||
- [Requirements](#requirements)
|
||||
- [What is FoxBin2Prg](#what-is-foxbin2prg)
|
||||
- [Advantages](#advantages)
|
||||
- [Example](#example)
|
||||
- [Usage](#usage)
|
||||
- [Keep reading](#keep-reading)
|
||||
|
||||
----
|
||||
# FoxBin2Prg - a Binary to Text converter for MS Visual Foxpro 9, SP1
|
||||
## Source
|
||||
Original repository at https://github.com/fdbozzo/foxbin2prg,
|
||||
this is a fork available on https://github.com/lscheffler/foxbin2prg/tree/fork
|
||||
This is a fork available on https://github.com/lscheffler/foxbin2prg
|
||||
|
||||
## Requirements
|
||||
- A copy of MS VFP9 SP1, at least _3504_
|
||||
- Runs with VFPA
|
||||
|
||||
## Demo video
|
||||
[See YouTube demo video of FoxBin2Prg used with PlasticSCM](http://youtu.be/sE4wQ50Itqg)
|
||||
|
||||
## What is FoxBin2Prg
|
||||
It is a program intended to be used with **SCM** tools (Source Code Managers, like VSS, CVS, SVN)
|
||||
and **DVCS** tools (like git, Mercurial, Plastic, and others),
|
||||
or as **standalone** program for _Diff_ (viewing differences) and _Merge_ operations,
|
||||
that pretends to substitute _SccText/X_ and _TwoFox_ and enhance their functionality,
|
||||
generating bidirectional PRG-Style versions that allow recreating the original binary file.
|
||||
### Advantages:
|
||||
|
||||
## Advantages
|
||||
- It generates _Text_ style programs (not compilable), for visual comparison out of FoxPros table based code.
|
||||
- It enables the change of the _Text_ version as easy as modifying a PRG
|
||||
- All the program code is in just one PRG, to simplify its maintainability
|
||||
- Out of the _Text_ versions you can **regenerate the original binaries**, so it is useful as backup
|
||||
- Out of the _Text_ versions you can **generate the original binaries**, so it is useful as backup
|
||||
- The extensions are configurable if you create a FOXBIN2PRG.CFG file
|
||||
- Inheritance of CFG configuration files between directories
|
||||
- Methods and properties of _Text_ version are alphabetically sorted for easy comparison
|
||||
@@ -43,11 +53,11 @@ generating bidirectional PRG-Style versions that allow recreating the original b
|
||||
- Get back your SourceSafe projects (.pjx) from their .pjm files
|
||||
- Don't infest a text based system like git with binaries
|
||||
|
||||
Currently supports the conversion between PJX, SCX, VCX, FRX, LBX, DBC, DBF and MNX files,
|
||||
for which a _Text_ version is generated with pj2, sc2, vc2, fr2, lb2, dc2, db2 and mn2 extensions.
|
||||
Currently supports the conversion between PJX, SCX, VCX, FRX, LBX, DBC, DBF, MNX, MEM and FKY files,
|
||||
for which a _Text_ version is generated with pj2, sc2, vc2, fr2, lb2, dc2, db2, mn2, me2 and fk2 extensions.
|
||||
The extensions may be reconfigured to be compatible with SCCAPI (just tested with SourceSafe).
|
||||
|
||||
### Example
|
||||
## Example
|
||||

|
||||

|
||||
|
||||
@@ -63,10 +73,15 @@ FoxBin2Prg can be used in tree ways:
|
||||
- Usable out of own code
|
||||
- expandable
|
||||
|
||||
## Keep reading:
|
||||
## Keep reading
|
||||
- [FoxBin2Prg Full Change History](./FoxBin2Prg_Changes.md)
|
||||
- [FoxBin2Prg Internals and Configuration](./FoxBin2Prg_Internals.md)
|
||||
- [FoxBin2Prg and use with SCM tools](./FoxBin2Prg_SCM.md)
|
||||
- [FoxBin2Prg Full Change History](./FoxBin2Prg_Changes.md)
|
||||
- [FoxBin2Prg and use with git](./FoxBin2Prg_git.md)
|
||||
|
||||
----
|
||||

|
||||
This project is part of VFPX.
|
||||
|
||||
----
|
||||
Last changed: _Pungenday, 53 Chaos 3187_ 
|
||||
Reference in New Issue
Block a user