https://github.com/vroncevic/gen_rv64asm
Generator RISC-V 64-bit assembly
https://github.com/vroncevic/gen_rv64asm
64-bit assembly code-generation freebsd generator linux macos python3 risc-v risc-v64
Last synced: about 1 month ago
JSON representation
Generator RISC-V 64-bit assembly
- Host: GitHub
- URL: https://github.com/vroncevic/gen_rv64asm
- Owner: vroncevic
- License: gpl-3.0
- Created: 2025-01-25T17:32:17.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-29T18:24:22.000Z (3 months ago)
- Last Synced: 2025-03-20T00:12:09.094Z (about 1 month ago)
- Topics: 64-bit, assembly, code-generation, freebsd, generator, linux, macos, python3, risc-v, risc-v64
- Language: Python
- Homepage: https://vroncevic.github.io/gen_rv64asm/
- Size: 555 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Create risc-v 64-bit asm project skeleton
**gen_rv64asm** is tool for creating risc-v 64-bit asm project skeleton.
Developed in **[python](https://www.python.org/)** code.
The README is used to introduce the modules and provide instructions on
how to install the modules, any machine dependencies it may have and any
other information that should be provided before the modules are installed.
[](https://github.com/vroncevic/gen_rv64asm/actions/workflows/gen_rv64asm_python_checker.yml) [](https://github.com/vroncevic/gen_rv64asm/actions/workflows/gen_rv64asm_package.yml) [](https://github.com/vroncevic/gen_rv64asm/issues) [](https://github.com/vroncevic/gen_rv64asm/graphs/contributors)
**Table of Contents**
- [Installation](#installation)
- [Install using pip](#install-using-pip)
- [Install using build](#install-using-build)
- [Install using py setup](#install-using-py-setup)
- [Install using docker](#install-using-docker)
- [Dependencies](#dependencies)
- [Tool structure](#tool-structure)
- [Docs](#docs)
- [Contributing](#contributing)
- [Copyright and Licence](#copyright-and-licence)
### Installation
Used next development environment
[](https://github.com/vroncevic/gen_rv64asm/actions/workflows/gen_rv64asm_python3_build.yml)
Currently there are four ways to install framework
* Install process based on using pip mechanism
* Install process based on build mechanism
* Install process based on setup.py mechanism
* Install process based on docker mechanism
##### Install using pip
Python is located at **[pypi.org](https://pypi.org/project/gen_rv64asm/)**.
You can install by using pip
```bash
#python3
pip3 install gen_rv64asm
```
##### Install using build
Navigate to **[release page](https://github.com/vroncevic/gen_rv64asm/releases)** download and extract release archive.
To install **gen-rv64asm** run
```bash
tar xvzf gen-rv64asm-x.y.z.tar.gz
cd gen-rv64asm-x.y.z
# python3
wget https://bootstrap.pypa.io/get-pip.py
python3 get-pip.py
python3 -m pip install --upgrade setuptools
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade build
pip3 install -r requirements.txt
python3 -m build -s --no-isolation --wheel
pip3 install dist/gen-rv64asm-x.y.z-py3-none-any.whl
rm -f get-pip.py
```
##### Install using py setup
Navigate to release **[page](https://github.com/vroncevic/gen_rv64asm/releases/)** download and extract release archive.
To install **gen_rv64asm** type the following
```bash
tar xvzf gen_rv64asm-x.y.z.tar.gz
cd gen_rv64asm-x.y.z/
# python3
pip3 install -r requirements.txt
python3 setup.py install_lib
python3 setup.py install_data
python3 setup.py install_egg_info
```
##### Install using docker
You can use Dockerfile to create image/container.
### Dependencies
**gen_rv64asm** requires next modules and libraries
* [ats-utilities - Python App/Tool/Script Utilities](https://vroncevic.github.io/gen_rv64asm)
### Tool structure
**gen_rv64asm** is based on OOP
Generator structure
```bash
gen_rv64asm/
├── conf/
│ ├── gen_rv64asm.cfg
│ ├── gen_rv64asm.logo
│ ├── gen_rv64asm_util.cfg
│ ├── project.yaml
│ └── template/
│ ├── asmflags.template
│ ├── ldflags.template
│ ├── main.template
│ ├── makefile.template
│ ├── objects.template
│ └── sources.template
├── __init__.py
├── log/
│ └── gen_rv64asm.log
├── pro/
│ ├── __init__.py
│ ├── read_template.py
│ └── write_template.py
├── py.typed
└── run/
└── gen_rv64asm_run.py
```
### Code coverage
| Name | Stmts | Miss | Cover |
|------|-------|------|-------|
| `gen_rv64asm/__init__.py` | 71 | 12 | 83% |
| `gen_rv64asm/pro/__init__.py` | 59 | 2 | 97% |
| `gen_rv64asm/pro/read_template.py` | 53 | 2 | 96% |
| `gen_rv64asm/pro/write_template.py` | 60 | 3 | 95% |
| **Total** | 243 | 19 | 92% |
### Docs
[](https://gen-rv64asm.readthedocs.io/en/latest/?badge=latest)
More documentation and info at
* [gen_rv64asm.readthedocs.io](https://gen-rv64asm.readthedocs.io)
* [www.python.org](https://www.python.org/)
### Contributing
[Contributing to gen_rv64asm](CONTRIBUTING.md)
### Copyright and Licence
[](https://www.gnu.org/licenses/gpl-3.0) [](https://opensource.org/licenses/Apache-2.0)
Copyright (C) 2025 by [vroncevic.github.io/gen_rv64asm](https://vroncevic.github.io/gen_rv64asm/)
**gen_rv64asm** is free software; you can redistribute it and/or modify
it under the same terms as Python itself, either Python version 3.x or,
at your option, any later version of Python 3 you may have available.
Lets help and support PSF.
[](https://www.python.org/psf/)
[](https://www.python.org/psf/donations/)