Skip to content

noahwooten05/plassemble

Repository files navigation

plassembler

Lines of Code Code size
An assembler written for the PLASM architecture.

Continous Integration

Below, badges for continous integration are available.

Platform Main
macOS (Latest) macOS Build
macOS (10.15) macOS Legacy Build
Linux (Ubuntu Latest) Ubuntu Build
Linux (Ubuntu LTS 18.04) Ubuntu LTS Build
Windows (Latest Release) Windows Build
Windows (Latest Debug) Windows Debug Build

Precompiled Binaries

Upon major milestone releases, precompiled releases are provided in the 'Releases' section on the right hand side of the desktop website.

Building yourself

Prerequisites

This project is a standalone console application that does not require any dependencies.

Getting the Source

You can download the archive source for building here, or if you want to contribute you can clone repository and use the git command line.
On many platforms, the syntax is as follows:

git clone https://github.com/[yourusername]/plassemble.git
git remote set-url origin git@github.com:[yourusername]/plassemble.git
git push -u origin master

macOS

For macOS, both Xcode 13.0 and makefile projects are available. You can open the project like this, or navigate to the root of the source and enter the following command.

make

In Xcode, you can use Command + B to build the project. Below the project source on the left hand side, a "Products" section allows you access the generated binary.

Linux (Ubuntu)

For Linux, a makefile project is available. Download or clone the source, and then navigate to the root folder. You can then build the project by typing the following command.

make

Windows

For Windows, the project can be built using the Visual Studio 2022 solution file present in the root of the repository.

Contribution

User contributions are considered, but not expected.

Code Style

The code style of the project should be maintained. Examples are given below.

Example Bad 1 Bad 2 Good
Variable Name helloVariable hello_variable HelloVariable
Function Name ModFunction Function mod_function
Type Case 1 long i32 int
Type Case 2 unsigned long unsigned i32 u32
File Name File.cpp File.ixx File.c

In general, from viewing the code the code style should be easily figured out. It is the descretion of the reviewer to determine what is okay, and this table may not always be consistent.

Tests

Under all circumstances, a pull request must pass every CI test before and after human contributor review. Afterwards, they may be merged with master.

License

This software is licensed under the BSD-3 license. A full text can be viewed here.

About

An assembler for the PLASM architecture.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published