Update README with build, test, setup, etc instructions.
This commit is contained in:
parent
0a030d4515
commit
a94340b281
|
@ -63,3 +63,4 @@ stamp-h[0-9]
|
|||
tmp
|
||||
/.version
|
||||
/doc/stamp-[0-9]
|
||||
/.envrc
|
||||
|
|
43
README.org
43
README.org
|
@ -1,4 +1,45 @@
|
|||
# -*- mode: org; coding: utf-8; -*-
|
||||
|
||||
#+TITLE: README for Guile-Nrepl
|
||||
#+TITLE: README for Guile-nREPL
|
||||
|
||||
* Description
|
||||
nREPL server implementation for guile.
|
||||
|
||||
* Spells for working with the project
|
||||
|
||||
If you have guix and org-mode, the src blocks in this section can be executed directly from this doc.
|
||||
|
||||
** Building
|
||||
To build the project, you need hall, autoconf, guile, and automake. If you are running guix, you just need to run a =guix shell= to get all the requirements.
|
||||
|
||||
#+begin_src shell
|
||||
guix shell -m manifest.scm -f guix.scm # Skip if you do not use guix
|
||||
hall build -x
|
||||
autoreconf -vif
|
||||
./configure
|
||||
make
|
||||
#+end_src
|
||||
|
||||
** Testing
|
||||
After the project is built, test the project via:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
make check
|
||||
#+END_SRC
|
||||
|
||||
** Cleaning
|
||||
To get back to a clean state, run:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
hall clean -x
|
||||
#+END_SRC
|
||||
|
||||
** Misc Incantations
|
||||
Other things that may be useful.
|
||||
*** Load shell in direnv
|
||||
If you use direnv, you can drop into the shell automatically with:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
echo 'eval $(guix shell --search-paths -m manifest.scm -f guix.scm)' > .envrc
|
||||
direnv allow
|
||||
#+END_SRC
|
||||
|
|
Loading…
Reference in New Issue