Browse Source

Update README, correct requirements.txt

README.md
=========
* Remove TODO for now-implemented RSS
* Add instructions for running, just in case

requirements.txt
================
* Change Hy line to match `pip freeze` output
main
Marie-Joseph 1 year ago
parent
commit
58d59a7f1f
  1. 17
      README.md
  2. 2
      requirements.txt

17
README.md

@ -4,5 +4,18 @@ This is the source code for my personal website and blog.
It's written using Flask in [Hy](https://docs.hylang.org), a Lisp which compiles to
Python AST, thence to Python bytecode. Yep, plain old Flask, written in a Lisp! Neat, huh?
## TODO
* RSS feed?
## Running
If, for some reason, you wish to run this website locally,
first make sure you have the requirements in `requirements.txt`.
At the time of writing, the version of Hy used is not in PyPI;
in order to get it, you will have to pull it from the git repository
like so: `pip install git+https://github.com/hylang/hy.git@1.0a1`.
This should be correct in the requirements file.
Then, run `source setup-flask` then `flask run`. All together:
```
git clone https://github.com/Marie-Joseph/hy-website.git
cd hy-website
pip install -r requirements.txt
source setup-flask
flask run
```

2
requirements.txt

@ -1,2 +1,2 @@
Flask>=1.1.2
hy>=1.0a1
hy @ git+https://github.com/hylang/hy.git@2d3af2a2db948a44caed042994a4f1779c8ea7c1