Skip to content

Commit

Permalink
[#2] Fix
Browse files Browse the repository at this point in the history
  • Loading branch information
vbmacher committed Nov 25, 2022
1 parent 22c9c78 commit d9d8944
Show file tree
Hide file tree
Showing 103 changed files with 9,991 additions and 565 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ modules.xml
_site/
.sass-cache/
.jekyll-metadata
.jekyll-cache

### Sass ###
*.css.map
Expand Down
5 changes: 4 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ source 'https://rubygems.org'

require 'json'
require 'open-uri'
versions = JSON.parse(open('https://pages.github.com/versions.json').read)
versions = JSON.parse(URI('https://pages.github.com/versions.json').read)

gem 'asciidoctor'
gem 'pygments.rb'
Expand All @@ -13,5 +13,8 @@ group :jekyll_plugins do
gem 'jekyll-sitemap', versions['jekyll-sitemap']
gem 'jekyll-asciidoc', '2.1.1'
gem 'jekyll-octicons'
gem 'jekyll-commonmark-ghpages', versions['jekyll-commonmark-ghpages']
gem 'asciidoctor-diagram'
end

gem "webrick", "~> 1.7"
40 changes: 39 additions & 1 deletion _data/downloads.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,44 @@ downloads:
}
]
}
- {
versionid: '36b1',
version: '3.6b1',
java: {
href: '',
name: 'Java 1.4'
},
release: {
date: 'on 2009-06-10',
href: ''
},
downloads: [
{
filename: 'emuStudio-3.6b1.zip',
href: '/files/emuStudio-3.6b1.zip',
glyphs: ['fa-windows', 'fa-linux']
}
]
}
- {
versionid: '35b1',
version: '3.5b1',
java: {
href: '',
name: 'Java 1.4'
},
release: {
date: 'on 2009-02-13',
href: ''
},
downloads: [
{
filename: 'emuStudio-3.5b1.zip',
href: '/files/emuStudio-3.5b1.zip',
gluphs: ['fa-windows', 'fa-linux']
}
]
}
- {
versionid: '001',
version: '0.1',
Expand All @@ -94,7 +132,7 @@ downloads:
downloads: [
{
filename: 'emu8-very-first.zip',
href: '{{ site.baseurl }}/files/emu8-very-first.zip',
href: '/files/emu8-very-first.zip',
glyphs: ['fa-windows', 'fa-linux']
}
]
Expand Down
2 changes: 1 addition & 1 deletion _data/global.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: 'emuStudio'
description: 'Computer emulation platform/framework'
url: 'https://www.emustudio.net' # the base hostname & protocol for your site
footer_text: '© Copyright 2006-2020, Peter Jakubčo'
footer_text: '© Copyright 2006-2022, Peter Jakubčo'

# Admin Settings
admin_name: 'Peter Jakubčo'
Expand Down
2 changes: 1 addition & 1 deletion _data/screenshots.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ screenshots:
have custom capabilities, for trying to mimic the behavior of a real-world.
</p>
<p class="lead">
Take an example - <a href="/documentation/user/altair8800/88-disk">88-DISK device</a> in MITS Altair8800 computer.
Take an example - <a href="/documentation/user/altair8800/88-dcdd">88-DCDD device</a> in MITS Altair8800 computer.
This device can be used for loading disk images containing files of some original vintage software.
</p>'
}
Expand Down
13 changes: 4 additions & 9 deletions _documentation/developer/Gemfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
source 'https://rubygems.org'

require 'json'
require 'open-uri'
versions = JSON.parse(open('https://pages.github.com/versions.json').read)

gem 'asciidoctor'
gem 'pygments.rb'
gem 'just-the-docs'
gem 'jekyll', '3.9.0'
gem 'webrick'
gem 'jekyll', '4.2.2'

group :jekyll_plugins do
gem 'github-pages', versions['github-pages']
gem 'jekyll', versions['jekyll']
gem 'jekyll-sitemap', versions['jekyll-sitemap']
gem 'jekyll-asciidoc', '2.1.1'
gem 'jekyll-sitemap'
gem 'jekyll-asciidoc'
gem 'asciidoctor-diagram'
end
47 changes: 29 additions & 18 deletions _documentation/developer/_doc/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,43 @@ permalink: /introduction/

This guide shall help you, the developer, to write your virtual computer for emuStudio. API is designed for simplicity and tries to save the developer from solving the most common problems. Created emulators can mimic either real or abstract computers. I hope you will have fun!

There exist some sister projects, which will be used by the developer during your programming journey. The following
## Sister projects

There exist some sister projects, which will be used by the developer during your programming journey. This
section will provide more information.

### emuLib

## emuLib
emuLib is a run-time library used by emuStudio and plugins; it represents the core communication bridge between the
application and virtual computer. Thus, it is mandatory to use it while developing any plugin for
emuStudio.

emuLib is a run-time library used by emuStudio and plugins. It also provides the API to be implemented by plug-ins.
Javadoc can be opened [here][emulib]{:target="_blank"}.

## edigen
### edigen

Edigen is CPU instruction decoder and disassembler generator using a binary specification file. It removes the burden of writing a boilerplate
disassembling code from the developer. It is however optional for using.

Project website with documentation is located [here][edigen]{:target="_blank"}.

### cpu-testsuite

Edigen is CPU instruction decoder and disassembler generator. It takes the burden of the common disassembling/decoding
code from the developer when programming an emulator. The project website, which includes documentation,
is [here][edigen]{:target="_blank"}.
General unit-testing framework intended for testing emuStudio CPU plug-ins. More specifically,
it allows to test correctness of the implementation of CPU instructions one by one. Tests are
specified in a declarative way; specific test cases are generated based on the declarative specification.

## Other documentation
Project website with documentation is located [here][edigen]{:target="_blank"}.

For reference, here are provided some documents for some older emuStudio versions.
## Publications

For reference, here are provided some published papers, mostly for some older emuStudio versions.

|---
| Version | Year | Document or paper
|-|-|-
| | 2020 | [Development of ATmega 328P micro-controller emulator for educational purposes][atmega-2020]{:target="_blank"}
|---
| | 2017 | [RASP Abstract Machine Emulator — Extending the emuStudio Platform][rasp-2017]{:target="_blank"}
|---
| | 2012 | [An instruction decoder and disassembler generator for EmuStudio platform][edigen-2012]{:target="_blank"} - Proceeding of the Faculty of Electrical Engineering and Informatics of the Technical University of Košice. Page 660-663. ISBN 978-80-553-0890-6
Expand All @@ -42,23 +57,19 @@ For reference, here are provided some documents for some older emuStudio version
|---
| | 2010 | [Standardization of computer emulation][standard-2010]{:target="_blank"}
|---
| | 2010 | [Communication model of emuStuio emulation platform][model-2010]{:target="_blank"}
|---
| 0.37b | 2009 | [User manual (in Slovak)][manual-2009]{:target="_blank"}
|---
| 0.37b | 2009 | [Plugins' vade-mecum (in Slovak)][vademecum-2009]{:target="_blank"}
| | 2010 | [Communication model of emuStudio emulation platform][model-2010]{:target="_blank"}
|---
| | 2008 | [Software-based CPU emulation][emulation-2008]{:target="_blank"}
|===


[emulib]: {{ site.baseurl }}/emulib_javadoc/
[edigen]: https://github.com/emustudio/edigen
[edigen]: https://github.com/emustudio/cpu-testsuite
[atmega-2020]: https://www.researchgate.net/publication/349929732_Development_of_ATmega_328P_micro-controller_emulator_for_educational_purposes
[rasp-2017]: https://www.researchgate.net/publication/320277321_RASP_ABSTRACT_MACHINE_EMULATOR_-_EXTENDING_THE_EMUSTUDIO_PLATFORM
[edigen-2012]: http://people.tuke.sk/dusan.medved/APVV/clanky/Bena4.pdf
[edigen-2012]: https://dusan.medved.website.tuke.sk/APVV/APVV-0385-07/clanky/Bena4.pdf
[standard-2010]: https://ieeexplore.ieee.org/document/5423733
[model-2010]: https://www.researchgate.net/publication/220482121_Communication_model_of_emuStudio_emulation_platform
[manual-2009]: {{ site.baseurl }}/../../../files/manual-0.37b-draft.pdf
[vademecum-2009]: {{ site.baseurl }}/../../../files/plugins-vademecum-old.pdf
[emulation-2008]: http://www.aei.tuke.sk/papers/2008/4/08_Simonak.pdf
[cse-2010]: {{ site.baseurl }}/../../../files/speed_final_en.pdf
[cse-2010]: {{ site.baseurl }}/assets/published/preserving-speed.pdf
4 changes: 2 additions & 2 deletions _documentation/developer/_doc/plugin_basics/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Then `[plugin type]` follows, but in a form, as it is shown in the following tab
|---
| Memory | `[some feature]-mem`, or `[computer type]-mem` | `standard-mem`, `ram-mem`, `brainduck-mem`
|---
| Device | `[device model]-[device type]` | `88-disk`, `adm3a-terminal`, `simh-pseudo`
| Device | `[device model]-[device type]` | `88-dcdd`, `adm3a-terminal`, `simh-pseudo`
|===


Expand Down Expand Up @@ -127,7 +127,7 @@ Then, in `application/build.gradle` are sections marked with `// Examples` or `/
into "bin"
}
}
["88-disk"].collect { device ->
["88-dcdd"].collect { device ->
from(scripts(":plugins:device:$device")) {
into "bin"
}
Expand Down
File renamed without changes.
13 changes: 4 additions & 9 deletions _documentation/user/Gemfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
source 'https://rubygems.org'

require 'json'
require 'open-uri'
versions = JSON.parse(open('https://pages.github.com/versions.json').read)

gem 'asciidoctor'
gem 'pygments.rb'
gem 'just-the-docs'
gem 'jekyll', '3.9.0'
gem 'webrick'
gem 'jekyll', '4.2.2'

group :jekyll_plugins do
gem 'github-pages', versions['github-pages']
gem 'jekyll', versions['jekyll']
gem 'jekyll-sitemap', versions['jekyll-sitemap']
gem 'jekyll-asciidoc', '2.1.1'
gem 'jekyll-sitemap'
gem 'jekyll-asciidoc'
gem 'asciidoctor-diagram'
end
Loading

0 comments on commit d9d8944

Please sign in to comment.