Skip to content

Create Reference “opencilk-programmers-guide” #211

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create Reference “opencilk-programmers-guide” #211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions src/doc/reference/opencilk-programmers-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
layout: layouts/page.njk
title: OpenCilk programmer's guide
author: Tao B. Schardl
date: 2023-04-05T20:02:58.977Z
attribution: false
---
Here is a place where we can add a concise reference guide about how to write a correct program with OpenCilk. (This would be very different than the "language reference" -- which gives "the final word" to "the language police" about what OpenCilk is.)

We might model the reference guide after one or more of these examples:

* GNU C reference manual, for example [here](https://www.gnu.org/software/gnu-c-manual/gnu-c-manual.html#Statements) – for C eagles.
* Julia manual, for example [here](https://docs.julialang.org/en/v1/manual/functions/) – for Julia eagles.
* Julia developer’s documentation, for example [here](https://docs.julialang.org/en/v1/devdocs/reflection/) – for Julia owls.
* Numpy reference, for example [here](https://numpy.org/doc/stable/reference/arrays.nditer.html#) – for Numpy eagles.