updated readme license and added github repo link

Author: tcorzo

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Tomás Corzo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,71 +1,22 @@
-# Abacus Emulator
+# Abacus Emulator 🧮
 
-Welcome to the Abacus Emulator project! This README provides an overview of the project, setup instructions, and usage guidelines.
+A simple emulator for a basic computer architecture, built with TypeScript and
+Deno.
 
-## Table of Contents
+## Setup Development Environment
 
-- [Introduction](#introduction)
-- [Features](#features)
-- [Installation](#installation)
-- [Usage](#usage)
-- [Contributing](#contributing)
-- [License](#license)
+1. Install [Deno](https://deno.land/manual/getting_started/installation)
+2. Clone this repository
+3. Install the dependencies:
+   ```bash
+   deno install
+   ```
+4. Run development server:
+   ```bash
+   deno task dev
+   ```
 
-## Introduction
+# Usage
 
-The Abacus Emulator is a software application that simulates the functionality of a traditional abacus. It is designed to help users learn and practice abacus operations digitally.
-
-## Features
-
-- Simulates a traditional abacus
-- User-friendly interface
-- Supports basic arithmetic operations
-- Educational tool for learning abacus
-
-## Installation
-
-To install the Abacus Emulator, follow these steps:
-
-1. Clone the repository:
-    ```bash
-    git clone https://github.com/yourusername/abacus-emulator.git
-    ```
-2. Navigate to the project directory:
-    ```bash
-    cd abacus-emulator
-    ```
-3. Install the required dependencies:
-    ```bash
-    npm install
-    ```
-
-## Usage
-
-To start using the Abacus Emulator, run the following command:
-```bash
-npm start
-```
-Open your web browser and navigate to `http://localhost:3000` to access the emulator.
-
-## Contributing
-
-We welcome contributions to the Abacus Emulator project! To contribute, please follow these steps:
-
-1. Fork the repository.
-2. Create a new branch:
-    ```bash
-    git checkout -b feature-branch
-    ```
-3. Make your changes and commit them:
-    ```bash
-    git commit -m "Description of changes"
-    ```
-4. Push to the branch:
-    ```bash
-    git push origin feature-branch
-    ```
-5. Create a pull request.
-
-## License
-
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+Checkout the [example_program.csv](test/fixtures/example_program.csv), use it as
+a template for your own programs.

index.html

@@ -13,4 +13,15 @@
   <script type="module" src="/src/main.ts"></script>
 </body>
 
+<div style="position: fixed; bottom: 20px; right: 20px;">
+  <a href="https://github.com/tcorzo/abacus-emulator" target="_blank" rel="noopener noreferrer">
+    <svg height="32" viewBox="0 0 16 16" width="32" style="fill: #fff;">
+      <path
+        d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z">
+      </path>
+    </svg>
+  </a>
+</div>
+
+
 </html>