https://github.com/hobbyoss/gosk
yet another assembly interpreter, like nask
https://github.com/hobbyoss/gosk
assembly-interpreter golang
Last synced: 3 months ago
JSON representation
yet another assembly interpreter, like nask
- Host: GitHub
- URL: https://github.com/hobbyoss/gosk
- Owner: HobbyOSs
- License: gpl-3.0
- Created: 2016-12-28T10:51:46.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2025-04-16T14:06:31.000Z (3 months ago)
- Last Synced: 2025-04-16T21:05:24.370Z (3 months ago)
- Topics: assembly-interpreter, golang
- Language: Go
- Homepage:
- Size: 1.04 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GOSK 
GOSK is an assembler project written in Go, designed to parse an assembly language similar to NASK (a language used in the "30 days self-made OS" book) and generate machine code (currently supporting COFF format). It utilizes PEG (Parsing Expression Grammar) for parsing.
## Features
* Parses NASK-like assembly code.
* Generates COFF object files.
* Includes a test suite for verification.
## Build & Run
Requires Go and Make installed.
```bash
# Clone the repository (if you haven't already)
# git clone https://github.com/HobbyOSs/gosk.git
# cd gosk
# Build the executable
make build
# Or install directly (might require setting up GOPATH/GOBIN)
# Note: This installs the command to your $GOPATH/bin or $GOBIN
go install github.com/HobbyOSs/gosk/cmd/gosk@latest
```
## Usage
```bash
# Display help message
./gosk --help
# Assemble a source file (e.g., input.nas) into an object file (e.g., output.o)
./gosk input.nas output.o
# Assemble and generate a listing file (e.g., output.lst)
./gosk input.nas output.o output.lst
```
The command-line interface is:
```
usage: ./gosk [--help | -v] source [object/binary] [list]
source: Input assembly file (.nas)
object/binary: Output object file (e.g., .o, .obj) or raw binary file (Optional, defaults based on source name)
list: Output listing file (Optional)
--help: Show this help message
-v: Show version and license information
```
## Contributing
Contributions are welcome! Please refer to the project's issue tracker and coding guidelines. (Details might be found in the `memory-bank` directory).
## License
This project is licensed under the [LICENSE](LICENSE) file.