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 some stuff to README.md and configure Gitpod #3

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# This configuration file was automatically generated by Gitpod.
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
# and commit this file to your remote git repository to share the goodness with others.

# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart

tasks:
- before: |
sudo apt-get update
sudo DEBIAN_FRONTEND=noninteractive apt-get -y install cmake flex
init: |
make -C faust install PREFIX=$HOME/.local
make install
make all
command: |
make serve

additionalRepositories:
- url: https://github.com/grame-cncm/faust.git
checkoutLocation: faustdoc/faust
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,12 @@
This repository is intended to build the documentation of the Faust environment, and to provide the corresponding examples.

### Prerequisites
- you must have make, "g++" (the GCC or Clang C++ driver), bison, and flex installed.
- you must have python, pip and [mkdocs](https://www.mkdocs.org/) installed.
- you must have the Faust source code installed. You can get it from [github](https://github.com/grame-cncm/faust). **Be sure to use a fresh cloned repository and to correcly install submodules with `git submodule update --init`**. The exact location can possibly be set in the make command using the `FAUSTDIR` environment variable.
- you must have Faust installed in PATH, too: it's used during the build.
[FIXME: does it need to be built in any particular way to get the right options in mkdocs/docs/manual/options.md?
Since that's checked in, this won't matter except when it actually needs to be updated.]
- you must have openssl installed for base64 conversion.

### WARNING: adding new files
Expand Down