Added a readme for the port

1 files changed, 47 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..af9177b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,47 @@
+#+title: Haskell Code Explorer
+
+This is an updated version of [[https://github.com/alexwl/haskell-code-explorer][Haskell Code Explorer]], it works with
+GHC-9.2.2 with Cabal-3.6.2.0, and possibly other adjacent versions.
+
+* Install
+
+#+begin_src sh
+cabal install
+#+end_src
+
+* Usage
+
+You'll need to index a package before serving it.
+
+A typical indexing workflow is as follows, take sqlite-simple as an
+example:
+
+#+begin_src sh
+cabal unpack sqlite-simple
+cd sqlite-simple-x.y.z.w
+cabal configure --enable-testsuites --enable-benchmarks
+cabal build
+haskell-code-indexer -p .
+#+end_src
+
+After this you can do
+
+#+begin_src sh
+haskell-code-server -p /path/to/package1 -p /path/to/packag2 ...
+#+end_src
+
+and the app will be available at localhost:3000.
+
+For the readme of the original version, see
+https://g.ypei.me/haskell-code-explorer.git/tree/README.md.
+
+* Contact and Copyright
+
+The original haskell-code-explorer is written by [[https://github.com/alexwl/][alexwl]], hosted at
+[[https://github.com/alexwl/haskell-code-explorer][github]].
+
+The port to 9.2.2 is done by Yuchen Pei (id@ypei.org).
+
+The original work is under the [[https://www.gnu.org/licenses/license-list.html#Expat][expat license]], while the changes by
+Yuchen Pei are covered by [[https://www.gnu.org/licenses/agpl-3.0.en.html][GNU AGPLv3+]].  This work as a whole is
+licensed under GNU AGPLv3+.