aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorArun Isaac2022-05-05 14:46:02 +0530
committerArun Isaac2022-05-05 14:46:02 +0530
commit849fe4e22b359942350d7f583780482f1852e4bb (patch)
tree97b503fbd96732de263c5e08b9b322cb224cd5ce /README.org
parente6554c63d6593c93cee381963645be843d2d6419 (diff)
downloadgn-transform-databases-849fe4e22b359942350d7f583780482f1852e4bb.tar.gz
README: Replace org mode with markdown.
Markdown is a simpler format and easier to render to the web. In particular, this change is prompted by Gitea not handling image links correctly. * README.org: Replace with ... * README.md: ... this.
Diffstat (limited to 'README.org')
-rw-r--r--README.org39
1 files changed, 0 insertions, 39 deletions
diff --git a/README.org b/README.org
deleted file mode 100644
index f5b0f4f..0000000
--- a/README.org
+++ /dev/null
@@ -1,39 +0,0 @@
-[[https://ci.genenetwork.org/jobs/dump-genenetwork-database-tests][https://ci.genenetwork.org/badge/dump-genenetwork-database-tests.svg]] [[https://ci.genenetwork.org/jobs/dump-genenetwork-database][https://ci.genenetwork.org/badge/dump-genenetwork-database.svg]]
-
-The GeneNetwork database is being migrated from a relational database
-to a plain text and RDF database. This repository contains code to
-dump the relational database to plain text.
-
-* Using
-
-Drop into a development environment with
-
-#+BEGIN_SRC shell
- $ guix shell
-#+END_SRC
-
-Describe the database connection parameters in a file /conn.scm/ file
-as shown below. Take care to replace the placeholders within angle
-brackets with the appropriate values.
-
-#+BEGIN_SRC scheme
- ((username . "<username-here>")
- (password . "<password-here>")
- (database . "<database-name-here>")
- (host . "<hostname-here>")
- (port . <port-here>))
-#+END_SRC
-
-Then, to dump the database to ~/data/dump, run
-
-#+BEGIN_SRC shell
- $ ./pre-inst-env ./dump.scm conn.scm ~/data/dump
-#+END_SRC
-
-Make sure there is enough free space! It's best to dump the database
-on penguin2 where disk space and bandwidth are not significant
-constraints.
-
-* Contributing
-
-See bugs and tasks in BUGS.org.