@andrivet/z80-assembler 1.4.0 → 1.4.1

package/{libs/z80-assembler/public/CHANGELOG.md → CHANGELOG.md}

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.4.1 - December 22, 2025
+
+* Fix wrong publication
+
+## 1.4.0 - December 22, 2025
+
+* Fix #8: 'Invalid ZX81 character' when using '9', 'Z' or 'z' in a string.
+
 ## 1.3.2 - November 20, 2024
 
 * Fix bugs introduced in commit 4bcb12ea82d38f83ce2079f8635909d0c5b5c57a

package/README.md

@@ -1,79 +1,53 @@
 # z80-assembler
 
-![Z80](assets/images/logo.png)
+A Z80 assembler library entirely written in Typescript and derived from a PEG grammar.
+It optimized for the old ZX81 computer but can also be used with any other Z80 targets.
 
-A Z80 assembler entirely written in Typescript and derived from a PEG grammar.
+## Demo application
 
-## Components
+A demo application is available: https://andrivet.github.io/z80-assembler/.
 
-* The first component is the library itself, `z80-assembler` that can be used like any npm library.
-* The second component is an application, `z80-assembler-app` that uses this library.
-  It can be used by itself or as an example of how to use the library. It is written in Typescript with React.
+## Quick guide to use the library
 
-![z80-assembler-app](assets/images/z80-assembler-app.png)
-
-This assembler is also used in the [ZX81 Debugger](https://github.com/andrivet/ZX81-Debugger).
-
-## How to build from source
+To install the library:
 
 ```
-npm --legacy-peer-deps install
-./node_modules/.bin/nx run z80-assembler-app:build:production
+$ npm install @andrivet/z80-assembler
 ```
 
-Notes: 
+The main function is simply called `compile`. It takes three arguments:
 
-* For the moment, you have to use `--legacy-peer-deps` because react-daisyui is not yet updated for DaisyUI 3.
-Once it is the case, this flag will no more be necessary.
+* the name of the source file
+* the Z80 source code to compile
+* a function used to return the content of included files
 
-* If you have installed NX globally, you do not need to specify its path.
+It returns an object of type `CompilationInfo` with the following fields:
 
-## How to run the application
+* `outputName`: The name of the output as set by the `output` directive.
+* `bytes`: A array of numbers. Each element represents a byte of the generated machine code.
+* `sld`: The Source Level Debugging data as a string. This is used in order to debug the code.
+* `errs`: An array of errors
+
+A typical way to use the function is:
 
 ```
-nx run z80-assembler-app:dev:production
+const info = compile(filepath, code, handleGetFileCode);
+if(info.errs.length > 0)
+  displayErrors(info.errs);
+else
+  saveOutput(info.outputName, info.bytes);
 ```
 
-Open a navigator at the URL http://localhost:4200/
-
-
-## Quick guide to use the application
-
-Under the **File** menu, you find the following commands:
-
-![Z80](assets/images/menu.png)
-
-* **Open Code**: Open a Z80 source file.
-* **Open Code Directory**: Open a directory with Z80 source files. This is especially useful if your source files contain includes.
-* **Save Code**: Save the current code file.
-* **Save Binary**: Save the compiled binary.
-* **Save SLD File**: Save the Source Level Debugging data in text format.
-* **Close Code**: Close the current code.
-* **Close All**: Close all the open codes.
-
-![Z80](assets/images/open-dir.png)
-
-Once one or more files are open, click on Compile to compile the code.
-The binary are displayed on the right side:
-
-![Z80](assets/images/compile.png)
-
-While writing your Z80 assembly code, you can display the list of Z80 opcodes by clicking on **Z80 Opcodes**:
-
-![Z80](assets/images/opcodes.png)
-
-Click on a category to see the corresponding opcodes:
-
-![Z80](assets/images/opcodes-load8.png)
+You can find a complete example in the [demo application](https://github.com/andrivet/z80-assembler/), in particular in the `app.tsx` file.
 
-## Z80 assembly
 
-The format of assembly source file is described in [Z80 Assembly Source Code Format](./docs/assembly.md).
+## Source code
 
+The source code is published on GitHub: https://github.com/andrivet/z80-assembler/.
 
 ## Licence
 
-This library and application are released under GPLv3.
+This library and associated application are released under GPLv3.
 
 ## Copyrights
 

package/{libs/z80-assembler/src/index.ts → index.d.ts}

@@ -7,7 +7,7 @@
  * License:		GPLv3
  * Copyrights: 	Copyright (C) 2023 Sebastien Andrivet
  */
-export * from './lib/types/Types'
+export * from './lib/types/Types';
 export * from './lib/types/Error';
 export * from './lib/compiler/Compiler';
 export * from './lib/compiler/Generator';