From 8d1f6e916b276219fc8cd4b773cde4d91fb52168 Mon Sep 17 00:00:00 2001 From: Aearnus Date: Sat, 26 May 2018 12:34:04 -0700 Subject: [PATCH] More readme --- README.md | 8 ++++++++ package.yaml | 6 +++--- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 610f0ef..ab04add 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,10 @@ test3f2 = replicateM_ 10 (inc (Accumulator)) Everything that this module exposes is in [src/DSL/SixtyFiveOhTwo.hs](https://github.com/Aearnus/dsl-sixty-five-oh-two/blob/master/src/DSL/SixtyFiveOhTwo.hs). A quick browse through this file will reveal the full extent of the features of this eDSL. +## What is this? + +This is an **e**mbedded **D**omain **S**pecific **L**anguage **** that allows a user to write code that runs on the 65C02 CPU. This is the CPU that runs devices such as the Apple II, Commodore 64, or the NES. + ## What does the language provide me? * **Full coverage**. Everything bit of code that the 65C02 can understand is represented in this language. Everywhere `adc` to `wai` can be used. These opcodes are represented as generic operations, each of which simply append to the bytecode that gets passed into it. Here's an example of the definition for a certain opcode: @@ -68,3 +72,7 @@ data AddressingMode = * **Easy abstractions**. The `define` and `call` keywords automatically generate the code necessary to create and call subroutines. + +## Support or Donate + +Please contact me if you have any wish to support this project or any other projects I've worked on. The information is in `package.yaml`. diff --git a/package.yaml b/package.yaml index 2d06ef5..3246da8 100644 --- a/package.yaml +++ b/package.yaml @@ -1,6 +1,6 @@ -name: sixty-five-oh-two +name: dsl-sixty-five-oh-two version: 0.1.0.0 -github: "githubuser/dsl-sixty-five-oh-two" +github: "aearnus/dsl-sixty-five-oh-two" license: MIT author: "Tyler Limkemann" maintainer: "tslimkemann42@gmail.com" @@ -17,7 +17,7 @@ category: DSL # To avoid duplicated efforts in documentation and dealing with the # complications of embedding Haddock markup inside cabal files, it is # common to point users to the README.md file. -description: An eDSL for writing 65(C)02 bytecode. Please see the README on GitHub at +description: An eDSL for writing 65(C)02 bytecode. Please see the README on GitHub at dependencies: - base >= 4.7 && < 5