<commit_before>Apricosim
=========

A cycle accurate simulator for the Apricos CPU architecture.



Dependencies
------------

This particular distribution of apricosim requires the following binaries:

- gcc 4.0.0+
- autoconf 2.65+
- automake 1.11+


The following libraries are also required:

- curses/ncurses


Compiling
---------

Compiling a minimal version of the simulator is as simple as entering the following commands:
```
aclocal
automake --add-missing
autoconf
./configure
make
sudo make install
```

For a fully featured version, which is required to run the Apricot OS, enter the following before `make`:
```
./configure --enable-tty-emulation --enable-port-emulation --enable-disk-emulation
```

Running
-------

To run the simulator without any programs, enter `aprsim` in your shell.

Besides running with no input, the simulator supports a number of command line parameters to customise execution:
`--version`          /  `-v`   Print version information and exit.
`--help`             /  `-h`   Print program usage information.
`--fifo_tty_file`    /  `-f`   Set fifo tty file. (Only if compiled with `enable-tty-emulation`)
`--serial_tty_file`  /  `-f`   Set serial tty file. (Only if compiled with `enable-tty-emulation`)
`--symbols`          /  `-s`   Load a symbols file.

Program binaries are listed after all other arguments, and are separated by spaces.


Using the simulator
-------------------

The simulator can be operated with the following controls:  
`j/k`   Scroll the memory display down/up.  
`J/K`   Scroll the stack display down/up.  
`r`     Toggle between register and CPU status display modes.  
`b`     Toggle a breakpoint.  
`m`     Toggle between state execution and instruction execution modes.  
`space` Execute one CPU state or instruction.  
`q`     Quit the simulator.  
`F1`    Interrupt the currently running program and quit the simulator.


Licence
-------<commit_msg>More readme format fixes<commit_after>Apricosim
=========

A cycle accurate simulator for the Apricos CPU architecture.



Dependencies
------------

This particular distribution of apricosim requires the following binaries:

- gcc 4.0.0+
- autoconf 2.65+
- automake 1.11+


The following libraries are also required:

- curses/ncurses


Compiling
---------

Compiling a minimal version of the simulator is as simple as entering the following commands:
```
aclocal
automake --add-missing
autoconf
./configure
make
sudo make install
```

For a fully featured version, which is required to run the Apricot OS, enter the following before `make`:
```
./configure --enable-tty-emulation --enable-port-emulation --enable-disk-emulation
```

Running
-------

To run the simulator without any programs, enter `aprsim` in your shell.

Besides running with no input, the simulator supports a number of command line parameters to customise execution:  
`--version`          /  `-v`   Print version information and exit.  
`--help`             /  `-h`   Print program usage information.  
`--fifo_tty_file`    /  `-f`   Set fifo tty file. (Only if compiled with `enable-tty-emulation`)  
`--serial_tty_file`  /  `-f`   Set serial tty file. (Only if compiled with `enable-tty-emulation`)  
`--symbols`          /  `-s`   Load a symbols file.  

Program binaries are listed after all other arguments, and are separated by spaces.


Using the simulator
-------------------

The simulator can be operated with the following controls:  
`j/k`   Scroll the memory display down/up.  
`J/K`   Scroll the stack display down/up.  
`r`     Toggle between register and CPU status display modes.  
`b`     Toggle a breakpoint.  
`m`     Toggle between state execution and instruction execution modes.  
`space` Execute one CPU state or instruction.  
`q`     Quit the simulator.  
`F1`    Interrupt the currently running program and quit the simulator.


Licence
-------
{'fraction_non_alphanumeric': 0.10964572019653478, 'fraction_numerical': 0.00517196793379881, 'mean_word_length': 2.91497975708502, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '36203', 'n_tokens_mistral': 1148, 'n_tokens_neox': 1076, 'n_words': 467}