Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Memorytaco committed Mar 17, 2019
1 parent 1986990 commit 371959c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
## `Flax` is renamed to `Melt` Now
# Note

`Melt` means `Meta Excellent Local Note System`. ( it may be renamed again ... )
maybe this is a release, but the basic working flow hasn't been setup.
be patient, i will do it in the next week!!!

Here is a first cli demo. It just has some basic interface now. it doesn't have
any real function currently.
the markdown has been built, support basic header, link, img, block code, inline code.(will add more features to it)

This is not a formal release though.
but the parser hasn't been built.

## Part Preview
- the init welcome page(use css framework)
![welcome](welcomePreview.png)

## Is there a demo page to view before i download it?

Yes, it is. Now the blog is not working.
Yes, it is. But now the blog is not working. after the markdown parser built,
i will do it soon.

You can View my Blog [Here](https://memorytoco.github.io/Lasga/).
It is purely genereted by **melt** along with some css style and maybe some js.
But i'm not quite familiar with front end so it may be ugly.
i'm not quite familiar with front end so it may be ugly.

> Because the melt is undering a big change, i'm unable to update the blog
> now. Having changed to a new temp blog which is generated by Hexo. --> [Lago](https://memorytoco.github.io/Lago/)
## Get started
1. Clone the repository to your machine.
2. use `helper` bash script
2. use `melt-install` bash script

```shell
$ ./helper install # use this to install
$ ./helper uninstall # use this to uninstall
$ ./melt-install install # use this to install
$ ./melt-install uninstall # use this to uninstall
```

## current status
Expand All @@ -39,11 +39,12 @@ $ ./helper uninstall # use this to uninstall
- [ ] add serve command
* `9%` building `lesh` help system
- [ ] build a fake shell for the system
* `3%` building markdown parser
* [x] building markdown parser
* `15%` adding error trackers
* `9%` adding unit test framework for melt

## maybe you are more interested on my temp blog

Here is it . --> [Lago](https://memorytoco.github.io/Lago/) <--

feel free to contact me @ **[email protected]** ,i will get you around .
2 changes: 2 additions & 0 deletions helper → melt-install
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#!/usr/bin/env bash

## this is the install script fo melt, will refine it later

if (( $# == 0)) ; then
echo -e '\x1B[37;1msubcommand:' '\x1B[0m'
echo ' 1) install'
Expand Down

0 comments on commit 371959c

Please sign in to comment.