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.

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

Add INSTALLING and README Markdown format #3

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

Conversation

gonidelis
Copy link

@gonidelis gonidelis commented Feb 23, 2021

Although the installation instructions needed for openCilk are pretty straightforward, inexperienced users might find it difficult to guide themselves amd fully build openCilk from source with the given instructions. I started the PR with the initial idea of just adding this example use case line, but then I decided to do some extra housekeeping for the sake of "user-friendliness".

Even if the PR gets rejected, I would recommend just putting together the building commands in a serial order, along with the trivial fib.c compilation example.

You can run the compiler out of its build tree, adding `/bin/clang` to
the build directory name. For example:

`./build/bin/clang fib.c -o fib -O3 -fopencilk`
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fwiw

@neboat
Copy link
Contributor

neboat commented Feb 24, 2021

I like this suggestion. In fact, on the current development version of this repository, on the dev branch, the README and INSTALLING files have already been converted to Markdown.

@gonidelis
Copy link
Author

@neboat Thanks. Ok I hadn't noticed. My focus was on the example use case. Do as you please :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants