Skip to content

Commit

Permalink
Fix readme comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroenbakker-atmind committed Jan 29, 2025
1 parent de89025 commit 88d448d
Showing 1 changed file with 6 additions and 20 deletions.
26 changes: 6 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,15 @@ let application = ApplicationBuilder::default()
)
.build(),
)
.build();
.build().unwrap();
```

After this the application can be generated to bytes (`Vec<u8>`) using the `ProgramGenerator`

```rust
use c64_assembler::generator::Generator;
use c64_assembler::generator::program::{ProgramGenerator, print_hexdump};
use c64_assembler::generator::{Generator, ProgramGenerator, print_hexdump};

let bytes = ProgramGenerator::default().generate(application);
let bytes = ProgramGenerator::default().generate(application).unwrap();
print_hexdump(&bytes);
```

Expand All @@ -74,10 +73,9 @@ print_hexdump(&bytes);
Or generate to dasm source using the `DasmGenerator`

```rust
use c64_assembler::generator::Generator;
use c64_assembler::generator::dasm::DasmGenerator;
use c64_assembler::generator::{Generator, DasmGenerator};

let source = DasmGenerator::default().generate(application);
let source = DasmGenerator::default().generate(application).unwrap();
println!("{}", source);
```

Expand Down Expand Up @@ -127,11 +125,9 @@ let application = application!(
rts
)
)
);
).unwrap();
```



## Development & Contribution

We welcome contributions! To get started:
Expand All @@ -152,16 +148,6 @@ We welcome contributions! To get started:

*Goal*: Initial release no macros

- Easy
- [x] Add VIC20 defines
- [x] Add SID defines
- Other
- [x] Add example explaining how to use the defines
- [ ] Add example/documentation for module
- [ ] Add example/documentation for functions
- [x] Add example to compile directly into a `.D64` file
- [x] Add test that performs a full roundtrip using MOS emulation

**Version 0.2**

*Goal*: Add macro support to reduce boiler plating
Expand Down

0 comments on commit 88d448d

Please sign in to comment.