Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding intro content to README.md #100

Merged
merged 4 commits into from
Mar 4, 2024
Merged

Adding intro content to README.md #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f9698e
Adding intro content to README.md
ChrisKXu Nov 24, 2023
6ad4b13
Add build/test instructions
ChrisKXu Nov 24, 2023
0b67732
update readme
ChrisKXu Mar 4, 2024
40290e8
update copyright
ChrisKXu Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Christopher Xu
Copyright (c) Chris Xu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
29 changes: 27 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,29 @@
# The Todl Programming Language
[![Main build](https://github.com/ChrisKXu/todl/actions/workflows/main_build.yml/badge.svg)](https://github.com/ChrisKXu/todl/actions/workflows/main_build.yml)

# todl
A simple yet practical general purpose programming language for fun
Todl is an experimental, general-purpose programming language that is built and runs on the .NET platform.

## System requirements
Todl can be run anywhere where .NET is supported, even on a Raspberry Pi or inside a docker container! Please refer to [this](https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md) page on the complete list of supported platforms and operating systems.

## Building and testing
Please make sure latest .NET 8 is installed and then run
```bash
$ dotnet build src
```
to build the project. Alternatively you can run
```bash
$ dotnet test src
```
to run all the tests.

## Running the samples
A great way to play with Todl is by running the samples. To do so, please make sure that the latest .NET 8 is installed and then run the following
```bash
$ dotnet publish src --configuration Debug
$ dotnet run --project samples/hello/hello.tdlproj
```

## Special thanks
* [Minsk](https://github.com/terrajobst/minsk), from which this project is inspired.
* [SharpLab.io](https://sharplab.io/), where I learned the MSIL stuff.
Loading