docs: Replace README.md with symlink to docs/README.rst.

quytelda · May 22, 2018 · 1c86c21 · 1c86c21
1 parent 533e508
commit 1c86c21
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 63 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1 @@
+docs/README.rst
diff --git a/docs/README.rst b/docs/README.rst
@@ -0,0 +1,26 @@
+####
+FOCS
+####
+
+Functional Open C Structures: A C Data Structures Library
+Current Version: ``focs-0.0.0-rc1`` (pre-release)
+
+What is FOCS?
+-------------
+
+FOCS is a data structure library implemented in C, designed to provide common data structures to C programs.  Additionally, FOCS aims to provide a functional programming bent to these data structures by providing common higher order functions like `map` and `fold` that can be used with all of these data structures.
+
+Documentation
+-------------
+
+See https://quytelda.github.io/focs/.
+
+Obtaining FOCS
+--------------
+
+See https://quytelda.github.io/focs/installation/obtaining.html.
+
+Building FOCS
+-------------
+
+See https://quytelda.github.io/focs/installation/makefile.html.