nicd/mebe
Archived
1
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity Actions

Add note about current status and how to minify build artifacts to readme

Browse source
This commit is contained in:
Mikko Ahlroth 2017-03-24 17:53:10 +02:00
parent 60d6e9b70e
commit eff03e4093
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -4,6 +4,10 @@
Mebe -- _the Minimalistic Elixir Blog Engine_ -- is a simple blog engine written in [Elixir](https://elixir-lang.org), Mebe -- _the Minimalistic Elixir Blog Engine_ -- is a simple blog engine written in [Elixir](https://elixir-lang.org),
using the [Phoenix Framework](http://www.phoenixframework.org/). using the [Phoenix Framework](http://www.phoenixframework.org/).
**NOTE:** Mebe is tailored for my own use at [my blog](https://blog.nytsoi.net/). Some
things are made configurable, but some are not and usage instructions are currently very
scarce. So proceed with caution.
The engine consists of two parts: The engine consists of two parts:
1. MebeEngine, which handles parsing the data files into an ETS (_Erlang Term Storage_) in-memory database, and 1. MebeEngine, which handles parsing the data files into an ETS (_Erlang Term Storage_) in-memory database, and
@ -13,7 +17,8 @@ The engine consists of two parts:
* `git clone` * `git clone`
* Copy `config/*.exs.dist`, removing the `.dist` ending and go through the configs. * Copy `config/*.exs.dist`, removing the `.dist` ending and go through the configs.
* `npm install && mix frontend.build` to build the frontend. * `npm install && mix frontend.build` to build the frontend. Use `MIX_ENV=prod` to build
minified files.
* Put some content into the data path you specified, at least a `menu` file. * Put some content into the data path you specified, at least a `menu` file.
* `mix phoenix.server` to run the development server. * `mix phoenix.server` to run the development server.