~wrycode/betterssg

4e4d4ae7d3573f3b14e9453aba4f74afe785d32e — Nick Econopouly 7 months ago 9f9b63a
Update readme with project status
2 files changed, 20 insertions(+), 28 deletions(-)

M README.md
M content/default/home.md
M README.md => README.md +10 -14
@@ 5,19 5,18 @@ betterssg is good for generating simple websites like
[osa1.net](https://osa1.net/). Use betterssg if you want to avoid [The
Bullshit Web](https://pxlnv.com/blog/bullshit-web/).

Release of version 1.0 (a very stable release) is planned for May 2019.

As of now, all documented features work well, but I have not done
extensive testing. I use it for my personal website:
[wrycode.com](https://wrycode.com).
UPDATE June 2019: I'm not planning to continue developing this
project, although I'm still using it for my personal website:
[wrycode.com](https://wrycode.com). As of now, all documented features
work well, but I have not done extensive testing.

## Installation

To build from source, install the dependencies via
[Quicklisp](https://www.quicklisp.org/beta/), and run `./build`.

Support for Windows and macOS is planned, but I have not tested on
either platform. The source code is already cross-platform (in
~~Support for Windows and macOS is planned, but I have not tested on
either platform.~~ The source code is already cross-platform (in
theory), so if you want to test it you can `(asdf:load-system
:betterssg)` and then use `(betterssg:main)` to build your site instead
of running the executable.


@@ 86,14 85,14 @@ Use betterssg.

## Planned Features

- HTML or plain text files in the content folder
- Javascript-free syntax highlighting of code blocks
- ~~HTML or plain text files in the content folder~~
- ~~Javascript-free syntax highlighting of code blocks~~
- RSS feed generation
- XML sitemap generation
- `--server` argument for running and refreshing a local webserver
- options regarding title case and date format

## Bugs
## Idiosyncrasies

- dated pages with no title must still have the trailing dash in the
  date: `2019-03-13-.md`


@@ 102,8 101,5 @@ Use betterssg.

## Other TODOs

- release for Windows and macOS
- Integrate a more complete markdown parser or document all supported
  markdown features
- implement testing
- ~~release for Windows and macOS~~


M content/default/home.md => content/default/home.md +10 -14
@@ 5,19 5,18 @@ betterssg is good for generating simple websites like
[osa1.net](https://osa1.net/). Use betterssg if you want to avoid [The
Bullshit Web](https://pxlnv.com/blog/bullshit-web/).

Release of version 1.0 (a very stable release) is planned for May 2019.

As of now, all documented features work well, but I have not done
extensive testing. I use it for my personal website:
[wrycode.com](https://wrycode.com).
UPDATE June 2019: I'm not planning to continue developing this
project, although I'm still using it for my personal website:
[wrycode.com](https://wrycode.com). As of now, all documented features
work well, but I have not done extensive testing.

## Installation

To build from source, install the dependencies via
[Quicklisp](https://www.quicklisp.org/beta/), and run `./build`.

Support for Windows and macOS is planned, but I have not tested on
either platform. The source code is already cross-platform (in
~~Support for Windows and macOS is planned, but I have not tested on
either platform.~~ The source code is already cross-platform (in
theory), so if you want to test it you can `(asdf:load-system
:betterssg)` and then use `(betterssg:main)` to build your site instead
of running the executable.


@@ 86,14 85,14 @@ Use betterssg.

## Planned Features

- HTML or plain text files in the content folder
- Javascript-free syntax highlighting of code blocks
- ~~HTML or plain text files in the content folder~~
- ~~Javascript-free syntax highlighting of code blocks~~
- RSS feed generation
- XML sitemap generation
- `--server` argument for running and refreshing a local webserver
- options regarding title case and date format

## Bugs
## Idiosyncrasies

- dated pages with no title must still have the trailing dash in the
  date: `2019-03-13-.md`


@@ 102,8 101,5 @@ Use betterssg.

## Other TODOs

- release for Windows and macOS
- Integrate a more complete markdown parser or document all supported
  markdown features
- implement testing
- ~~release for Windows and macOS~~