Skip to content

Commit

Permalink
+[meta] Better installing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
leostera committed Dec 16, 2018
1 parent 2206ec7 commit c12b006
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 1 deletion.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
deps:
opam install --deps-only .

.PHONY: install
install:
dune install

.PHONY: build
build:
dune build
Expand Down
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,27 @@ Cactus is a reaction to the amount of static site generators out there
that enforce their structures on you. Cactus does very little. If you open it
up, you'll find it's full of water.

### Getting Started
### Installing

`cactus` requires a working OCaml toolchain with opam. If you have it, you can
just pin the repository:

```sh
opam pin add cactus https://github.com/ostera/cactus.git
```

If you'd rather run from source you can also `git clone` and `make install`:

```sh
git clone https://github.com/ostera/cactus path/to/projects
cd path/to/projects
make install
```

Worht noting that `make install` just calls `dune install`.


## Getting Started

Cactus works in a very simple way. In fact it's almost silly how simple it is.
If you put a `cactus-project` file on the root of your project, cactus will look
Expand Down
3 changes: 3 additions & 0 deletions cactus.install
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ lib: [
bin: [
"_build/install/default/bin/cactus" {"cactus"}
]
doc: [
"_build/install/default/doc/cactus/README.md"
]
3 changes: 3 additions & 0 deletions cactus.opam
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@ depends: [
"dune"
"reason"
]
build: [make "build"]
install: [make "install"]

0 comments on commit c12b006

Please sign in to comment.