diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 19 insertions, 14 deletions
@@ -3,10 +3,13 @@ A place where I can make some bad decisions. Puck is an experimental, memory safe, strongly typed, multi-paradigm programming language. -It aims to be clean and succinct while performant: having the ease of use of [Python](https://www.python.org/) with the performance/safety guarantees of [Rust](https://www.rust-lang.org/) and the flexibility/metaprogramming of [Nim](https://nim-lang.org/). +It aims to be clean and succinct while performant: having the flexibility/metaprogramming of [Nim](https://nim-lang.org/) with the performance/safety guarantees of [Rust](https://www.rust-lang.org/) and the error handling of [Swift](https://www.swift.org/). You may judge for yourself if Puck meets these ideals. +```puck +``` + ## Why Puck? Puck is primarily a testing ground and should not be used in any important capacity. @@ -20,23 +23,25 @@ That said: in the future, once somewhat stabilized, reasons why you *would* use - The **interop system**, allowing foreign functions to be usable with native semantics from a bevy of popular languages <!-- - The **effect system**, being one of few languages with a proper effects system based on handlers --> +This is the language I keep in my head. It sprung from a series of unstructured notes I kept on language design, that finally became something more comprehensive in early 2023. The overarching goal is to provide a language capable of elegantly expressing any problem, and explore ownership and interop along the way. + ## How do I learn more? -- The [basic usage](BASIC.md) document lays out the fundamental grammar of Puck. -- The [syntax](SYNTAX.md) document provides a deeper and formal look into the syntax choices made. -- The [type system](TYPES.md) document gives an in-depth analysis of Puck's extensive type system. <!-- and its relationship to classes and other abstractions. --> -- The [memory management](MEMORY_MANAGEMENT.md) document gives an overview of Puck's memory model. <!-- which is considered a mashup of the models pioneered by Lobster, Rust, and Nim. --> -- The [metaprogramming](METAPROGRAMMING.md) document explains how using metaprogramming to extend the language works. <!-- and write more powerful code works. --> -- The [asynchronous](ASYNC.md) document gives an overview of the intertwining of Puck's asynchronous support with other language features. -- The [effect system](EFFECTS.md) document gives a description of how Puck's effect handler system works. -- The [interop](INTEROP.md) document gives an overview of how the first-class language interop system works. -- The [modules](MODULES.md) document provides a more detailed look at imports and how they relate to the type system. -- The [standard library](STDLIB.md) document provides an overview and examples of usage of the standard library. -- The [roadmap](ROADMAP.md) provides a clear view of the current state and future plans of the language's development. +- The [basic usage](docs/BASIC.md) document lays out the fundamental grammar of Puck. +- The [syntax](docs/SYNTAX.md) document provides a deeper and formal look into the syntax choices made. +- The [type system](docs/TYPES.md) document gives an in-depth analysis of Puck's extensive type system. <!-- and its relationship to classes and other abstractions. --> +- The [memory management](docs/MEMORY_MANAGEMENT.md) document gives an overview of Puck's memory model. <!-- which is considered a mashup of the models pioneered by Lobster, Rust, and Nim. --> +- The [metaprogramming](docs/METAPROGRAMMING.md) document explains how using metaprogramming to extend the language works. <!-- and write more powerful code works. --> +- The [asynchronous](docs/ASYNC.md) document gives an overview of the intertwining of Puck's asynchronous support with other language features. +- The [interop](docs/INTEROP.md) document gives an overview of how the first-class language interop system works. +- The [modules](docs/MODULES.md) document provides a more detailed look at imports and how they relate to the type system. +<!-- - The [effect system](docs/EFFECTS.md) document gives a description of how Puck's effect handler system works. --> +- The [standard library](docs/STDLIB.md) document provides an overview and examples of usage of the standard library. +- The [roadmap](docs/ROADMAP.md) provides a clear view of the current state and future plans of the language's development. These are best read in order. -Note that all of these documents (and parts of this README) are written as if everything already exists. Nothing already exists! You can see the [roadmap](ROADMAP.md) for an actual sense as to the state of the language. I simply found writing in the present tense to be an easier way to collect my thoughts. +Note that all of these documents (and parts of this README) are written as if everything already exists. Nothing already exists! You can see the [roadmap](docs/ROADMAP.md) for an actual sense as to the state of the language. I simply found writing in the present tense to be an easier way to collect my thoughts. ## Acknowledgements @@ -44,4 +49,4 @@ First and foremost, this language is *heavily* inspired by Nim. Many ideas - gen The error handling model, and purity system, were essentially directly lifted from Swift (and to an extent, Nim). The underlying type system is mostly copied from Rust, with significant changes to the interface (trait) and module system. The memory model is based upon similar successful models in Lobster, Nim, and Rust. Performance annotations are somewhat inspired by Nim. -The effects system is unique, with inspiration from the few languages successfully implementing effects systems, namely Koka and Unison. +<!-- The effects system is unique, with inspiration from the few languages successfully implementing effects systems, namely Koka and Unison. --> |