Apple-2gs-SW
/
ORCA-C
mirror of https://github.com/byteworksinc/ORCA-C.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add instructions for converting line endings. 

The procedure for automatically converting them using Git filters is from Kelvin Sherlock, with some adjustments.
This commit is contained in:
Stephen Heumann 2017-10-21 20:09:08 -05:00
parent 46b6aa389f
commit 408e2e4462
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -16,3 +16,33 @@ The general conditions that must be met before a change is released on master ar
Contact support@byteworks.us if you need contributor access.
A complete distribution of the ORCA languages, including installers and documentation, is available from the Juiced GS store at https://juiced.gs/store/category/software/. It is distributed as part of the Opus ][ package.
## Line Endings
The text and source files in this repository originally used CR line endings, as usual for Apple II text files, but they have been converted to use LF line endings because that is the format expected by Git. If you wish to move them to a real or emulated Apple II and build them there, you will need to convert them back to CR line endings.
If you wish, you can configure Git to perform line ending conversions as files are checked in and out of the Git repository. With this configuration, the files in your local working copy will contain CR line endings suitable for use on an Apple II. To set this up, perform the following steps in your local copy of the Git repository (these should be done when your working copy has no uncommitted changes):
1. Add the following lines at the end of the `.git/config` file:
```
[filter "crtext"]
clean = LC_CTYPE=C tr \\\\r \\\\n
smudge = LC_CTYPE=C tr \\\\n \\\\r
```
2. Add the following lines to the `.git/info/attributes` file, creating it if necessary:
```
* filter=crtext
bin/Libraries/* -filter
bin/Languages/* -filter
```
3. Run the following commands to convert the existing files in your working copy:
```
rm .git/index
git checkout HEAD -- .
```
Alternatively, you can keep the LF line endings in your working copy of the Git repository, but convert them when you copy the files to an Apple II. There are various tools to do this. One option is `udl`, which is [available][udl] both as a IIGS shell utility and as C code that can be built and used on modern systems.
[udl]: http://ftp.gno.org/pub/apple2/gs.specific/gno/file.convert/udl.114.shk