Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
maiste committed Aug 29, 2024
1 parent 11082ed commit 3083c02
Showing 1 changed file with 41 additions and 7 deletions.
48 changes: 41 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,51 @@
> :warning: This website is still active but is under a complet redesign :safety_vest: New stuffs incoming! :camel:
# Maiste.fr - A garden for my digital life

## Personal blog
> :warning: This website is still active but is under a complete redesign
> :safety_vest: New stuffs incoming! :camel:
This blog is built with the wonderful OCaml framework `YOCaml`.
## Context

Feel free to inspire yourself from it!
As a true privacy believer, I think it's important to keep control over your
data and be able to host your website on your own. This project is an attempt
(with more and less success) to bring my stone to the edifice!

This blog is built with the wonderful OCaml framework `YOCaml`. Feel free to
inspire yourself from it!

## Install deps
FIXME: add a installation instructions

As the project is built using _OCaml_, it currently uses _opam_ to manage
dependencies. To install the project, simply run:

```sh
$ opam switch create . --deps-only $ eval $(opam env)
```

If you want to also install the dependencies for a development purpose, you
need to add the `--with-dev-setup`:

```sh
$ opam switch create . --deps-only --with-dev-setup $ eval $(opam env)
```

## Run the builder
FIXME: add running informations

To execute our code, we rely on `dune`. To produce the content in the _target/_
directory, run:

```sh
$ dune exec ./bin/maiste.exe
```

If you want to lunch the development server, you can run the same command with
the `serve` option:

```sh
$ dune exec ./bin/maiste.exe serve
```

## License
FIXME: add informations about the license

All the code under this project is under the [GPL3](./LICENSE) license. The
content of the blog is under [CC BY-NC
4.0](https://creativecommons.org/licenses/by-nc/4.0/?ref=chooser-v1).

0 comments on commit 3083c02

Please sign in to comment.