update documentation

Author: mipmip

CHANGLOG.md

@@ -1,68 +1,4 @@
-
-# Changelog Lindex
-
-# 0.2.1 - 19 feb 2020
-- index: _index_docs_tasks
-
-# 0.2.0 - 22 October 2019
-- config: TRM wordt TAX
-- config: VAL wordt TRM
-- config: wiki_indexes wordt L0-CONF-ROOT ... zie spec
-- config: L2 wordt L1
-- config: L3 wordt L2
-- index: _index_term_values_starred wordt _index_terms_starred
-- index: _index_keys wordt _index_taxonomies
-- index: _index_docs_with_keys.json wordt _index_docs_with_props.json
-- code: l2 wordt l1
-- code: l3 wordt l2
-
-# 0.1.7
-- arrays
-
-# 0.1.6
-- can fully replace wimpi-scripts
-- also index int, float and bool
-- show version
-- self info
-- release
-
-# 0.1.5
-- hernoemen naar Lindex
-- travis testen
-- versie bijwerken
-- brew bijwerken en testen
-
-# 0.1.4
-- delete all index files part of indexer + spec
-- def write_title_index + erb + spec
-- wimpi vim database laten wijzen naar wimpix-spec
-- wimpix_main_conf_vervangen met 3 nieuwe paden (db/state/index)
-- fix coverage
-- confs l2 aanmaken
-- confs l3 aanmaken
-- L2-INDEX_TRM_xxxx.json
-- L3-INDEX_TRM_xxxx_VAL_yyyy de kock.json
-- _index_term_values_starred.json
-- wimpix cli laten werken met ander paden
-
-# 0.1.3
-- spec starred.json
-- _index_keys.json + spec
-- _index_docs_with_keys.json + spec
-- _index_docs_with_title.json + spec
-
-# 0.1.2
-- test mock data
-- spec home dir independent
-- _index_docs_starred.json
-
-# 0.1.1
-- read config
+# Changelog Carl
 
 # 0.1.0
-- crystal framework
-- project repo
-- build stuff
-- test framework
-- coverage
-- cli lib
+- initial implentation of Linden Specification 0.2

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Pim Snel
+Copyright (c) 2021 Pim Snel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,5 +1,30 @@
-# Carl, a linden indexer implemented in Hugo
+# Carl
 
+Carl is a Linden Indexer implemented in Hugo.
+
+## Install
+
+To be able to run Carl you need to have installed a recent version of
+[Hugo](https://gohugo.io/). At time of writing this was 0.8.1.
+
+To install Carl clone this repository to a place on your harddrive.
+
+```
+git clone https://github.com/linden-project/carl ~/MyLindenWiki
+```
+
+## Start Carl as daemon
+
+Run to start Carl as a Linden Indexer execute the following commands.
+
+```
+cd ~/MyLindenWiki
+hugo server \
+  --renderToDisk \
+  --ignoreCache \
+  --forceSyncStatic \
+  --cleanDestinationDir \
+  --disableFastRender
 
 ## Contributors