Apple-2-SW/4live
1
0
Fork 0
mirror of https://github.com/a2-4am/4live.git synced 2024-06-25 17:29:35 +00:00
Code Issues Projects Releases Wiki Activity

first real README

Browse Source
This commit is contained in:
4am 2016-11-06 14:46:00 -05:00
parent 0099edb301
commit eecaf1ebbb
1 changed files with 40 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -1 +1,40 @@
# 4live
# 4live
4live is a scratchpad for keeping notes while you're working on your Apple II under DOS 3.3 or a compatible third-party DOS. The current version allows you to keep a 40x23 screen of freeform text, accessible at any time that DOS is in memory by hitting a global hotkey.
## For users
Install 4live by typing `BRUN _4LIVE` from the BASIC prompt, or by executing it in your `HELLO` program.
```10 PRINT CHR$(4);"BRUN _4LIVE"```
Now you can press `<Ctrl-@>` at any time to enter the 4live editor. This works from the BASIC prompt or the monitor -- even in the middle of typing a command -- as long as DOS is in memory and connected. (If you can do a `CATALOG`, DOS is connected.)
Keyboard commands within the 4live editor:
* `<Ctrl-@>` or `<Esc>` exits the 4live editor.
* Arrows move freely up, down, left, and right. On an Apple II Plus, you can use `<Ctrl-K>` and `<Ctrl-J>` in place of up and down arrows.
* `<Return>` moves the cursor to the beginning of the next line. It does not erase any text on the current line. It will wrap around from the bottom of the screen to the top.
* `<Ctrl-N>` clears the editor screen and erases all your data.
* `<Ctrl-I>` imports the "real" text screen you were looking at before you entered the editor (like taking a text screenshot). This overwrites the entire scratchpad and erases all your data.
4live will automatically save the contents of your scratchpad on exit. (Currently it saves to the file `_4LIVE DATA`. You will see this file in the disk catalog.)
# 4live for developers
4live is written in 100% 6502 assembly language, but it is developed on modern PCs (not in a "classic" IDE like Merlin-8). The source code is stored and managed in text files. These text files are assembled to executable code with [ACME](https://sourceforge.net/projects/acme-crossass/), then transferred to a disk image (`.dsk` file) with [AppleCommander](http://applecommander.sourceforge.net/). You can mount this disk image in any Apple II emulator.
If you are on Mac OS X and have the [Virtual II](http://virtualii.com/) emulator, you can use the included Applescript to mount the `.dsk` file and reboot the emulator automatically. The included `Makefile` does this by default (after running ACME and AppleCommander).
Thus, during development, my testing cycle goes like this:
1. Edit `.a` source code file in modern editor
2. Run `make`
3. Test in Virtual II
4. GOTO 1
## Acknowledgments
Thanks to [Peter Ferrie, a.k.a. qkumba](https://github.com/peterferrie) for his many contributions to this project.
Thanks to [Quinn Dunki](https://github.com/blondie7575) for her help integrating the [Apple II build pipeline](https://github.com/blondie7575/Apple2BuildPipeline) into my development environment.